Notificações

Recuperar todos

GET https://xerp.ae/api/notification-handlers/
curl --request GET \
--url 'https://xerp.ae/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
Parâmetros Detalhes Descrição
search Opcional Cadeia A string de pesquisa.
search_by Opcional Cadeia Por qual campo você está pesquisando. Os valores permitidos são: name.
is_enabled Opcional Boolean
type Opcional Cadeia Por qual campo você está pesquisando. Os valores permitidos são: email, webhook, slack, discord, telegram, microsoft_teams, twilio, twilio_call, whatsapp, x, google_chat, internal_notification, push_subscriber_id, sixsixtext_save_contact.
datetime_field Opcional Cadeia Valores permitidos: datetime, last_datetime
datetime_start Opcional Cadeia Filtre os resultados a partir desta data e hora. Formato Y-m-d H:i:s.
datetime_end Opcional Cadeia Filtre os resultados até esta data e hora. Formato Y-m-d H:i:s.
order_by Opcional Cadeia Por qual campo ordenar os resultados. Os valores permitidos são: notification_handler_id, datetime, last_datetime, name.
order_type Opcional Cadeia A ordenação dos resultados. Os valores permitidos são: ASC para ordenação ascendente e DESC para ordenação descendente.
search Opcional Cadeia A string de pesquisa.
search_by Opcional Cadeia Por qual campo você está pesquisando. Os valores permitidos são: name.
is_enabled Opcional Boolean
type Opcional Cadeia Por qual campo você está pesquisando. Os valores permitidos são: email, webhook, slack, discord, telegram, microsoft_teams, twilio, twilio_call, whatsapp, x, google_chat, internal_notification, push_subscriber_id, sixsixtext_save_contact.
datetime_field Opcional Cadeia Valores permitidos: datetime, last_datetime
datetime_start Opcional Cadeia Filtre os resultados a partir desta data e hora. Formato Y-m-d H:i:s.
datetime_end Opcional Cadeia Filtre os resultados até esta data e hora. Formato Y-m-d H:i:s.
order_by Opcional Cadeia Por qual campo ordenar os resultados. Os valores permitidos são: notification_handler_id, datetime, last_datetime, name.
order_type Opcional Cadeia A ordenação dos resultados. Os valores permitidos são: ASC para ordenação ascendente e DESC para ordenação descendente.
page Opcional Inteiro O número da página que 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": "hey@example.com"
            },
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2026-07-15 20:12:59",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://xerp.ae/api/notification-handlers?page=1",
        "last": "https://xerp.ae/api/notification-handlers?page=1",
        "next": null,
        "prev": null,
        "self": "https://xerp.ae/api/notification-handlers?page=1"
    }
}

Recuperar um

GET https://xerp.ae/api/notification-handlers/{notification_handler_id}
curl --request GET \
--url 'https://xerp.ae/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "type": "email",
        "name": "Work email",
        "settings": {
            "email": "hey@example.com"
        },
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-07-15 20:12:59",
    }
}

Criar

POST https://xerp.ae/api/notification-handlers
Parâmetros Detalhes Descrição
name Obrigatório Cadeia -
type Obrigatório Cadeia Valores permitidos: email, webhook, slack, discord, telegram, microsoft_teams, twilio, twilio_call, whatsapp, x, google_chat, internal_notification, push_subscriber_id, sixsixtext_save_contact
email Opcional Cadeia Disponível quando: type = email Email
webhook Opcional Cadeia Disponível quando: type = webhook URL do webhook
slack Opcional Cadeia Disponível quando: type = slack URL do webhook do Slack
discord Opcional Cadeia Disponível quando: type = discord URL do webhook do Discord
telegram Opcional Cadeia Disponível quando: type = telegram Token da API do Telegram
telegram_chat_id Opcional Cadeia Disponível quando: type = telegram ID do Chat do Telegram
microsoft_teams Opcional Cadeia Disponível quando: type = microsoft_teams URL do webhook do Microsoft Teams
google_chat Opcional Cadeia Disponível quando: type = google_chat URL do webhook do chat do Google
x_consumer_key Opcional Cadeia Disponível quando: type = x Token da API do Telegram
x_consumer_secret Opcional Cadeia Disponível quando: type = x Token da API do Telegram
x_access_token Opcional Cadeia Disponível quando: type = x Token da API do Telegram
x_access_token_secret Opcional Cadeia Disponível quando: type = x Token da API do Telegram
push_subscriber_id Opcional Cadeia Disponível quando: type = push_subscriber_id Inscrito push
twilio Opcional Cadeia Disponível quando: type = twilio Número de telefone
twilio_call Opcional Cadeia Disponível quando: type = twilio_call Número de telefone
whatsapp Opcional Cadeia Disponível quando: type = whatsapp Número de telefone
sixsixtext_save_contact_api_key Opcional Cadeia Disponível quando: type = sixsixtext_save_contact chave de API
sixsixtext_save_contact_phone_number Opcional Cadeia Disponível quando: type = sixsixtext_save_contact Número de telefone de teste
curl --request POST \
--url 'https://xerp.ae/api/notification-handlers' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'type=email' \
--form 'email=hello@example.com' \
{
    "data": {
        "id": 1
    }
}

Atualizar

POST https://xerp.ae/api/notification-handlers/{notification_handler_id}
Parâmetros Detalhes Descrição
name Opcional Cadeia -
type Opcional Cadeia Valores permitidos: email, webhook, slack, discord, telegram, microsoft_teams, twilio, twilio_call, whatsapp, x, google_chat, internal_notification, push_subscriber_id, sixsixtext_save_contact
email Opcional Cadeia Disponível quando: type = email Email
webhook Opcional Cadeia Disponível quando: type = webhook URL do webhook
slack Opcional Cadeia Disponível quando: type = slack URL do webhook do Slack
discord Opcional Cadeia Disponível quando: type = discord URL do webhook do Discord
telegram Opcional Cadeia Disponível quando: type = telegram Token da API do Telegram
telegram_chat_id Opcional Cadeia Disponível quando: type = telegram ID do Chat do Telegram
microsoft_teams Opcional Cadeia Disponível quando: type = microsoft_teams URL do webhook do Microsoft Teams
google_chat Opcional Cadeia Disponível quando: type = google_chat URL do webhook do chat do Google
x_consumer_key Opcional Cadeia Disponível quando: type = x Token da API do Telegram
x_consumer_secret Opcional Cadeia Disponível quando: type = x Token da API do Telegram
x_access_token Opcional Cadeia Disponível quando: type = x Token da API do Telegram
x_access_token_secret Opcional Cadeia Disponível quando: type = x Token da API do Telegram
push_subscriber_id Opcional Cadeia Disponível quando: type = push_subscriber_id Inscrito push
twilio Opcional Cadeia Disponível quando: type = twilio Número de telefone
twilio_call Opcional Cadeia Disponível quando: type = twilio_call Número de telefone
whatsapp Opcional Cadeia Disponível quando: type = whatsapp Número de telefone
sixsixtext_save_contact_api_key Opcional Cadeia Disponível quando: type = sixsixtext_save_contact chave de API
sixsixtext_save_contact_phone_number Opcional Cadeia Disponível quando: type = sixsixtext_save_contact Número de telefone de teste
is_enabled Opcional Boolean -
curl --request POST \
--url 'https://xerp.ae/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
    }
}

Apagar

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