Webhooks

Vous pouvez créer, visualiser et supprimer des webhooks via ce point de terminaison. Alternativement, vous pouvez gérer vos webhooks dans l'application web dans la zone Développeur.

GET/api/hooks

Afficher les webhooks actifs

Interroger les webhooks actifs de votre compte.

Requête

GET
/api/hooks
curl -G "https://gateway.seven.io/api/hooks" \
    -H "X-Api-Key: VOTRE_CLÉ_API"

Réponse

{
  "success": true,
  "code": null,
  "hooks": [
    {
      "id": "410",
      "target_url": "https://acme.inc/v1/webhooks",
      "headers": "",
      "event_type": "sms_mo",
      "event_filter": "49157123456789",
      "request_method": "GET",
      "enabled": true,
      "created": "2021-03-01 11:19:08"
    },
    {
      "id": "1277",
      "target_url": "https://hooks.seven.io/hook",
      "headers": "Authorization: Basic dXNlcjpwYXNz",
      "event_type": "all",
      "event_filter": null,
      "request_method": "JSON",
      "enabled": false,
      "created": "2021-12-30 13:33:02"
    },
    {
      "id": "1808"
      // ...
    }
  ]
}
POST/api/hooks

Enregistrer un webhook

Paramètres

  • Name
    target_url
    Type
    string
    Description

    Adresse de destination de votre webhook

  • Name
    headers
    Type
    string
    Description

    En-têtes personnalisés à envoyer à l'URL du webhook. Peut contenir plusieurs en-têtes séparés par un saut de ligne.

  • Name
    event_type
    Type
    enum
    Description

    Type d'événement pour lequel vous souhaitez recevoir un webhook.

    Afficher les événements

    all - Envoie tous les événements
    rcs - Événements RCS et messages RCS entrants
    sms_mo - Nouveaux SMS entrants
    dlr - Rapports de statut de vos SMS
    voice_call - Informations sur les appels vocaux
    voice_status - Mises à jour de statut des appels vocaux
    voice_dtmf - Signaux DTMF entrants dans les appels vocaux
    tracking - Clics ou vues du Suivi de performance

  • Name
    event_filter
    Type
    string
    Optional
    Optional
    Description

    Optionnel. Envoie le webhook seulement si le filtre s'applique. Par exemple, pour différents webhooks avec différents numéros entrants.

  • Name
    request_method
    Type
    enum
    Optional
    Optional
    Description

    Méthode de requête dans laquelle vous souhaitez recevoir le webhook.

    POST - Les données sont envoyées comme requête HTTP POST en application/x-www-form-urlencoded (par défaut) GET - Les données sont envoyées comme paramètre HTTP GET JSON - Les données sont envoyées via HTTP POST comme charge utile JSON

Requête

POST
/api/hooks
curl -X POST "https://gateway.seven.io/api/hooks" \
    -H "X-Api-Key: VOTRE_CLÉ_API" \
    -d "target_url=https://acme.inc/webhook/" \
    -d "event_type=all"

Réponse

{
    "success": true,
    "code": null,
    "id": 12345,
    "error_message": null
}
DELETE/api/hooks

Supprimer un webhook

Appelez l'API avec les mêmes paramètres avec lesquels le webhook a été créé (target_url, event_type, request_method) pour le supprimer à nouveau. Alternativement, vous pouvez supprimer un webhook directement via l'ID respectif. Pour cela, entrez le paramètre id.

Vous recevrez le même retour que lors de la création du webhook.

Paramètre (supprimer par ID)

  • Name
    id
    Type
    integer
    Description

    L'ID du webhook que vous voulez supprimer.

Requête

DELETE
/api/hooks
curl -X DELETE "https://gateway.seven.io/api/hooks" \
    -H "X-Api-Key: VOTRE_CLÉ_API" \
    -d "id=123456"

Réponse

{
    "success": true,
    "code": null,
    "id": 12345,
    "error_message": null
}