Notifications

Récupérer tous

GET https://xerp.ae/api/notification-handlers/
curl --request GET \
--url 'https://xerp.ae/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
Paramètres Détails Description
search Opcional Cadeia A string de pesquisa.
search_by Opcional Cadeia Champ dans lequel vous effectuez la recherche. Les valeurs autorisées sont : name.
is_enabled Opcional Boolean
type Opcional Cadeia Champ dans lequel vous effectuez la recherche. Les valeurs autorisées sont : 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 Valeures permitidos: datetime, last_datetime
datetime_start Opcional Cadeia Filtre les résultats a partir desta date et heure. Format Y-m-d H:i:s.
datetime_end Opcional Cadeia Filtre les résultats jusqu’à cette date et heure. Format Y-m-d H:i:s.
order_by Opcional Cadeia Champ selon lequel trier les résultats. Les valeurs autorisées sont : notification_handler_id, datetime, last_datetime, name.
order_type Opcional Cadeia Ordre des résultats. Les valeurs autorisées sont : ASC pour l’ordre croissant et DESC pour l’ordre décroissant.
search Opcional Cadeia A string de pesquisa.
search_by Opcional Cadeia Champ dans lequel vous effectuez la recherche. Les valeurs autorisées sont : name.
is_enabled Opcional Boolean
type Opcional Cadeia Champ dans lequel vous effectuez la recherche. Les valeurs autorisées sont : 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 Valeures permitidos: datetime, last_datetime
datetime_start Opcional Cadeia Filtre les résultats a partir desta date et heure. Format Y-m-d H:i:s.
datetime_end Opcional Cadeia Filtre les résultats jusqu’à cette date et heure. Format Y-m-d H:i:s.
order_by Opcional Cadeia Champ selon lequel trier les résultats. Les valeurs autorisées sont : notification_handler_id, datetime, last_datetime, name.
order_type Opcional Cadeia Ordre des résultats. Les valeurs autorisées sont : ASC pour l’ordre croissant et DESC pour l’ordre décroissant.
page Opcional Inteiro O numéro de la page que souhaitez résultats. O défaut est 1.
results_per_page Opcional Inteiro Nombre de résultats souhaités par page. Les valeurs autorisées sont : 10, 25, 50, 100, 250, 500, 1000. La valeur par défaut est 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:13:21",
        }
    ],
    "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"
    }
}

Récupérer un

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:13:21",
    }
}

Créer

POST https://xerp.ae/api/notification-handlers
Paramètres Détails Description
name Obligatoire Cadeia -
type Obligatoire Cadeia Valeures 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 Disponible quand: type = email E-mail
webhook Opcional Cadeia Disponible quand: type = webhook URL du webhook
slack Opcional Cadeia Disponible quand: type = slack URL du webhook du Slack
discord Opcional Cadeia Disponible quand: type = discord URL du webhook du Discord
telegram Opcional Cadeia Disponible quand: type = telegram Token de la API du Telegram
telegram_chat_id Opcional Cadeia Disponible quand: type = telegram ID du Chat du Telegram
microsoft_teams Opcional Cadeia Disponible quand: type = microsoft_teams URL du webhook du Microsoft Teams
google_chat Opcional Cadeia Disponible quand: type = google_chat URL du webhook du chat du Google
x_consumer_key Opcional Cadeia Disponible quand: type = x Token de la API du Telegram
x_consumer_secret Opcional Cadeia Disponible quand: type = x Token de la API du Telegram
x_access_token Opcional Cadeia Disponible quand: type = x Token de la API du Telegram
x_access_token_secret Opcional Cadeia Disponible quand: type = x Token de la API du Telegram
push_subscriber_id Opcional Cadeia Disponible quand: type = push_subscriber_id Inscrito push
twilio Opcional Cadeia Disponible quand: type = twilio Numéro de téléphone
twilio_call Opcional Cadeia Disponible quand: type = twilio_call Numéro de téléphone
whatsapp Opcional Cadeia Disponible quand: type = whatsapp Numéro de téléphone
sixsixtext_save_contact_api_key Opcional Cadeia Disponible quand: type = sixsixtext_save_contact Clé API
sixsixtext_save_contact_phone_number Opcional Cadeia Disponible quand: type = sixsixtext_save_contact Numéro de téléphone de test
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
    }
}

Mettre Ă  jour

POST https://xerp.ae/api/notification-handlers/{notification_handler_id}
Paramètres Détails Description
name Opcional Cadeia -
type Opcional Cadeia Valeures 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 Disponible quand: type = email E-mail
webhook Opcional Cadeia Disponible quand: type = webhook URL du webhook
slack Opcional Cadeia Disponible quand: type = slack URL du webhook du Slack
discord Opcional Cadeia Disponible quand: type = discord URL du webhook du Discord
telegram Opcional Cadeia Disponible quand: type = telegram Token de la API du Telegram
telegram_chat_id Opcional Cadeia Disponible quand: type = telegram ID du Chat du Telegram
microsoft_teams Opcional Cadeia Disponible quand: type = microsoft_teams URL du webhook du Microsoft Teams
google_chat Opcional Cadeia Disponible quand: type = google_chat URL du webhook du chat du Google
x_consumer_key Opcional Cadeia Disponible quand: type = x Token de la API du Telegram
x_consumer_secret Opcional Cadeia Disponible quand: type = x Token de la API du Telegram
x_access_token Opcional Cadeia Disponible quand: type = x Token de la API du Telegram
x_access_token_secret Opcional Cadeia Disponible quand: type = x Token de la API du Telegram
push_subscriber_id Opcional Cadeia Disponible quand: type = push_subscriber_id Inscrito push
twilio Opcional Cadeia Disponible quand: type = twilio Numéro de téléphone
twilio_call Opcional Cadeia Disponible quand: type = twilio_call Numéro de téléphone
whatsapp Opcional Cadeia Disponible quand: type = whatsapp Numéro de téléphone
sixsixtext_save_contact_api_key Opcional Cadeia Disponible quand: type = sixsixtext_save_contact Clé API
sixsixtext_save_contact_phone_number Opcional Cadeia Disponible quand: type = sixsixtext_save_contact Numéro de téléphone de test
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
    }
}

Supprimer

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}' \