Webhooks
Was der Webhook sendet
Ein Webhook ist eine Adresse auf Ihrer Seite, an die BulkGate meldet, was mit
Ihren Nachrichten passiert ist. Im Portal heißt er Zustellungsberichte, er
empfängt jedoch zwei Dinge zugleich:
| Was ankommt | Woran Sie es erkennen |
|---|---|
| Zustellbericht | Ein Datensatz mit dem Status einer gesendeten Nachricht und ihrer smsID |
| Eingehende SMS (Antwort) | Ein Datensatz mit status 10, dem Absender in from und dem Text der Nachricht |
Es handelt sich also nicht um zwei getrennte Einstellungen – eine einzige Adresse verarbeitet sowohl Zustellberichte als auch Antworten.
Das Datenformat hängt davon ab, ob der Sammelversand eingeschaltet ist:
| Modus | Wie die Daten ankommen | Format beschrieben unter |
|---|---|---|
| Standard | Eine Anfrage pro Nachricht, per GET | Zustellbestätigungen |
Massen-DLRs - Massenanfrage |
Ein Batch von Datensätzen, per POST mit application/json |
Sammel-Zustellbestätigungen |
Wo der Webhook eingestellt wird
Der Ort hängt von der verwendeten Schnittstelle ab. Die ersten beiden Schritte sind
immer gleich – klicken Sie im Menü des Portals auf Module und APIs und öffnen Sie
unter Meine APIs und Module die Karte Ihrer Anwendung.
| Schnittstelle | Wo im Detail der Anwendung |
|---|---|
| HTTP API | Reiter Die Einstellungen (Settings), Bereich Web hooks, Karte Zustellungsberichte |
Email > SMS |
Nur E-Mail-Zustellungsberichte – die Berichte kommen per E-Mail, nicht an eine URL |
So schalten Sie den Webhook ein
Die Karte zeigt, ob bereits etwas eingestellt ist. Solange nichts eingestellt ist,
zeigt sie Sie haben keine Einstellungen. und die Schaltfläche Konfigurieren.
Die Schaltfläche Konfigurieren (bzw. Bearbeiten, wenn Sie bereits Einstellungen
haben) öffnet das Fenster Zustellungsberichte einstellen.
Geben Sie in das Feld URL-Zustellungsberichte eine Adresse ein, die mit http://
oder https:// beginnt – eine andere Schreibweise akzeptiert das Portal nicht.
Dazu gehören drei Kontrollkästchen:
| Option | Was sie bewirkt |
|---|---|
Deaktivieren Sie die URL-Verfügbarkeitsprüfung |
Das Portal prüft vor dem Speichern nicht, ob die Adresse antwortet |
Nur berichten, wenn ein Fehler auftritt |
Ein Bericht kommt nur bei einer fehlgeschlagenen Nachricht |
Massen-DLRs - Massenanfrage |
Die Berichte kommen gesammelt in Batches statt einzeln |
Die Einstellung speichern Sie mit der Schaltfläche sparen (Save).
Der Sammelversand lohnt sich bei hohen Volumen – statt einer Anfrage pro Nachricht kommt eine einzige Anfrage mit einem Array von Datensätzen. Das Batch-Format ist unter Sammel-Zustellbestätigungen beschrieben.
Sobald der Webhook eingestellt ist, zeigt die Karte drei Zeilen – URL mit der
Adresse und je ein Symbol für Nur berichten, wenn ein Fehler auftritt und
Massen-DLRs - Massenanfrage, das anzeigt, ob die Option eingeschaltet ist.
So entfernen Sie den Webhook
Der Pfeil neben der Schaltfläche Bearbeiten öffnet ein Menü mit der Option
Löschen. Das Bestätigungsfenster Einstellungen löschen warnt, dass Sie Ihre
Einstellungen für Zustellberichte verlieren und diese nicht mehr ankommen.
Wenn Sie den Webhook entfernen, kommen auch keine eingehenden Nachrichten mehr an – Antworten auf Ihre SMS können nirgendwohin zugestellt werden.
Vielen Dank für Ihr Feedback.