Webhooks

Über diesen Endpunkt können Sie Webhooks erstellen, einsehen und löschen. Alternativ können Sie Ihre Webhooks in der Webapp im Bereich Entwickler verwalten.

GET/api/hooks

Webhooks auslesen

Fragen Sie die aktiven Webhooks Ihres Accounts ab.

Anfrage

GET

/api/hooks

curl -G "https://gateway.seven.io/api/hooks" \
    -H "X-Api-Key: IHR_API_SCHLÜSSEL"

Antwort

{
  "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"
    }
  ]
}

POST/api/hooks

Webhook registrieren

Parameter

Name
target_url
Type
string
Description
Zieladresse Ihres Webhooks
Name
headers
Type
string
Description
HTTP Header, die Sie mit dem Webhook senden möchten. Zum Beispiel für Authentifizierung. Mehrere Header werden durch \n getrennt.
Name
event_type
Type
enum
Description
Art des Events, für dass Sie einen Webhook erhalten möchten.
Ereignisse anzeigen
all – Sendet alle Ereignisse
rcs - RCS Ereignisse und eingehende RCS Nachrichten
sms_mo – Neue Inbound SMS
wa_mo – Neue eingehende WhatsApp-Nachricht
dlr – Statusberichte Ihrer SMS
voice_call – Info über eingehende Anrufe in Voicecalls
voice_status – Aktualisierungen für Voicecalls
voice_dtmf – DTMF-Signale in Voicecalls
tracking – Klicks bzw. Views des Performance Tracking
Name
event_filter
Type
string
Optional
Optional
Description
Optional. Wird nur bei sms_mo verwendet: die Inboundnummer im internationalen Format ohne Plus, z.B. 4915112345678. Der Webhook wird nur für eingehende SMS an diese Nummer gesendet, etwa um verschiedene Inboundnummern an verschiedene URLs zu leiten.
Bei allen anderen Event-Typen bleibt das Feld leer. Es wird dort nicht ausgewertet, ein gesetzter Wert verhindert die Zustellung des Webhooks.
Name
request_method
Type
enum
Optional
Optional
Description
Requestmethode, in der Sie den Webhook erhalten möchten.
POST - Daten werden als HTTP POST Request als application/x-www-form-urlencoded (Standard) gesendet
GET - Daten werden als HTTP GET Parameter gesendet
JSON - Daten werden per HTTP POST als JSON Payload gesendet

Anfrage

POST

/api/hooks

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

Anfrage (eingehende SMS nach Nummer gefiltert)

POST

/api/hooks

curl -X POST "https://gateway.seven.io/api/hooks" \
    -H "X-Api-Key: IHR_API_SCHLÜSSEL" \
    -d "target_url=https://acme.inc/webhook/sms" \
    -d "event_type=sms_mo" \
    -d "event_filter=4915112345678"

Antwort

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

DELETE/api/hooks

Webhook löschen

Rufen Sie die API mit denselben Parametern auf, mit denen der Webhook erstellt wurde (target_url,event_type,request_method), um diesen wieder zu löschen. Alternativ können Sie einen Webhook direkt über die jeweilige ID löschen. Geben Sie hierzu den Parameter id an.

Sie erhalten dieselbe Rückgabe wie beim Erstellen des Webhooks.

Parameter (Löschen per ID)

Name
id
Type
integer
Description
Die ID des Webhooks, den Sie löschen möchten.

Anfrage

DELETE

/api/hooks

curl -X DELETE "https://gateway.seven.io/api/hooks" \
    -H "X-Api-Key: IHR_API_SCHLÜSSEL" \
    -d "id=123456"

Antwort

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