Handlers de notificação

Listar todos

GET https://virt.cards/api/notification-handlers/
curl --request GET \
--url 'https://virt.cards/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
Parâmetros Detalhes Descrição
page Opcional Inteiro O número da página da qual você quer resultados. Padrão é 1.
results_per_page Opcional Inteiro Quantos resultados por página você deseja. Valores permitidos: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Padrão é 25. 
{
    "data": [
        {
            "id": 1,
            "type": "email",
            "name": "Work email",
            "settings": {
                "email": "[email protected]"
            },
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2025-09-13 18:02:05",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://virt.cards/api/notification-handlers?page=1",
        "last": "https://virt.cards/api/notification-handlers?page=1",
        "next": null,
        "prev": null,
        "self": "https://virt.cards/api/notification-handlers?page=1"
    }
}

Listar um

GET https://virt.cards/api/notification-handlers/{notification_handler_id}
curl --request GET \
--url 'https://virt.cards/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "type": "email",
        "name": "Work email",
        "settings": {
            "email": "[email protected]"
        },
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2025-09-13 18:02:05",
    }
}

Criar

POST https://virt.cards/api/notification-handlers
Parâmetros Detalhes Descrição
name Obrigatório String -
type Obrigatório String Valores permitidos: email , webhook , slack , discord , telegram , microsoft_teams
email Opcional String Disponível quando: type = email Email
webhook Opcional String Disponível quando: type = webhook URL do webhook
slack Opcional String Disponível quando: type = slack URL do webhook do Slack
discord Opcional String Disponível quando: type = discord URL do webhook do Discord
telegram Opcional String Disponível quando: type = telegram Token da API do Telegram
telegram_chat_id Opcional String Disponível quando: type = telegram Chat ID do Telegram
microsoft_teams Opcional String Disponível quando: type = microsoft_teams URL do webhook do Microsoft Teams
curl --request POST \
--url 'https://virt.cards/api/notification-handlers' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'type=email' \
--form 'email=[email protected]' \
{
    "data": {
        "id": 1
    }
}

Atualizar

POST https://virt.cards/api/notification-handlers/{notification_handler_id}
Parâmetros Detalhes Descrição
name Opcional String -
type Opcional String Valores permitidos: email , webhook , slack , discord , telegram , microsoft_teams
email Opcional String Disponível quando: type = email Email
webhook Opcional String Disponível quando: type = webhook URL do webhook
slack Opcional String Disponível quando: type = slack URL do webhook do Slack
discord Opcional String Disponível quando: type = discord URL do webhook do Discord
telegram Opcional String Disponível quando: type = telegram Token da API do Telegram
telegram_chat_id Opcional String Disponível quando: type = telegram Chat ID do Telegram
microsoft_teams Opcional String Disponível quando: type = microsoft_teams URL do webhook do Microsoft Teams
is_enabled Opcional Booleano -
curl --request POST \
--url 'https://virt.cards/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example new name' \
--form 'is_enabled=1' \
{
    "data": {
        "id": 1
    }
}

Excluir

DELETE https://virt.cards/api/notification-handlers/{notification_handler_id}
curl --request DELETE \
--url 'https://virt.cards/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \