Manipuladores de notificação

Recuperar tudo

GET https://zipa.la/api/notification-handlers/
curl --request GET \
--url 'https://zipa.la/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ê deseja resultados. O padrão é 1.
results_per_page Opcional Inteiro Quantos resultados você deseja por página. Os valores permitidos são: 10 , 25 , 50 , 100 , 250 , 500 , 1000. O padrão é 25. 
{
    "data": [
        {
            "id": 1,
            "type": "email",
            "name": "Work email",
            "settings": {
                "email": "[email protected]"
            },
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2025-12-05 14:22:49",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://zipa.la/api/notification-handlers?page=1",
        "last": "https://zipa.la/api/notification-handlers?page=1",
        "next": null,
        "prev": null,
        "self": "https://zipa.la/api/notification-handlers?page=1"
    }
}

Recuperar um

GET https://zipa.la/api/notification-handlers/{notification_handler_id}
curl --request GET \
--url 'https://zipa.la/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-12-05 14:22:49",
    }
}

Criar

POST https://zipa.la/api/notification-handlers
Parâmetros Detalhes Descrição
name Obrigatório Corda -
type Obrigatório Corda Valores permitidos: email , webhook , slack , discord , telegram , microsoft_teams , whatsapp , x , google_chat , internal_notification
email Opcional Corda Disponível quando: type = email Email
webhook Opcional Corda Disponível quando: type = webhook URL do webhook
slack Opcional Corda Disponível quando: type = slack URL do webhook do Slack
discord Opcional Corda Disponível quando: type = discord URL do webhook do Discord
telegram Opcional Corda Disponível quando: type = telegram Token da API do Telegram
telegram_chat_id Opcional Corda Disponível quando: type = telegram Telegram Chat ID
microsoft_teams Opcional Corda Disponível quando: type = microsoft_teams URL do webhook do Microsoft Teams
google_chat Opcional Corda Disponível quando: type = google_chat URL do webhook do bate-papo do Google
x_consumer_key Opcional Corda Disponível quando: type = x Token da API do Telegram
x_consumer_secret Opcional Corda Disponível quando: type = x Token da API do Telegram
x_access_token Opcional Corda Disponível quando: type = x Token da API do Telegram
x_access_token_secret Opcional Corda Disponível quando: type = x Token da API do Telegram
whatsapp Opcional Corda Disponível quando: type = whatsapp Número de telefone
curl --request POST \
--url 'https://zipa.la/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://zipa.la/api/notification-handlers/{notification_handler_id}
Parâmetros Detalhes Descrição
name Opcional Corda -
type Opcional Corda Valores permitidos: email , webhook , slack , discord , telegram , microsoft_teams , whatsapp , x , google_chat , internal_notification
email Opcional Corda Disponível quando: type = email Email
webhook Opcional Corda Disponível quando: type = webhook URL do webhook
slack Opcional Corda Disponível quando: type = slack URL do webhook do Slack
discord Opcional Corda Disponível quando: type = discord URL do webhook do Discord
telegram Opcional Corda Disponível quando: type = telegram Token da API do Telegram
telegram_chat_id Opcional Corda Disponível quando: type = telegram Telegram Chat ID
microsoft_teams Opcional Corda Disponível quando: type = microsoft_teams URL do webhook do Microsoft Teams
google_chat Opcional Corda Disponível quando: type = google_chat URL do webhook do bate-papo do Google
x_consumer_key Opcional Corda Disponível quando: type = x Token da API do Telegram
x_consumer_secret Opcional Corda Disponível quando: type = x Token da API do Telegram
x_access_token Opcional Corda Disponível quando: type = x Token da API do Telegram
x_access_token_secret Opcional Corda Disponível quando: type = x Token da API do Telegram
whatsapp Opcional Corda Disponível quando: type = whatsapp Número de telefone
is_enabled Opcional Booleano -
curl --request POST \
--url 'https://zipa.la/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://zipa.la/api/notification-handlers/{notification_handler_id}
curl --request DELETE \
--url 'https://zipa.la/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \