Webhooks für die On-Premises API
Abonniere Webhooks und erhalte Benachrichtigungen über Nachrichten, die dein Unternehmen empfängt, sowie Änderungen an Kundenprofilen. Weitere Informationen zu Webhooks für die WhatsApp Business Platform findest du unter Übersicht, Webhooks.
Die Einrichtung von Webhooks hat keine Auswirkungen auf die Telefonnummer in deiner WhatsApp Business App Sobald du deine Telefonnummer über die WhatsApp Business Platform migriert hast, kannst du diese Nummer nicht mehr in der WhatsApp Business App verwenden.
Bevor du beginnst
Was du benötigst:
- Code, der HTTPS unterstützt und über ein gültiges SSL-Zertifikat verfügt
- Ein Rückruf-URL-Endpunkt, der so konfiguriert ist, dass er eingehende Anfragen der Coreapp annimmt
- Ein Rückruf-URL-Endpunkt, der eine
HTTPS 200 OK-Antwort zurückgibt, wenn eine Benachrichtigung empfangen wird
Erneut versuchen
Wenn eine Benachrichtigung aus beliebigem Grund nicht übermittelt wird oder die Webhook-Anfrage einen anderen HTTP-Statuscode als 200 zurückgibt, wiederholen wir die Webhook-Auslieferung. Die Auslieferung wird in immer größeren Intervallen bis zu einer bestimmten Zeitüberschreitung (in der Regel 24 Stunden, kann jedoch variieren) oder bis zur erfolgreichen Auslieferung erneut versucht.
Einrichten deines Rückruf-URL-Endpunkts
Sende eine PATCH-Anfrage an den /v1/settings/application-Endpunkt und legen den webhooks-Parameter auf deinen Rückruf-URL-Endpunkt fest. Weitere häufig konfigurierte Parameter sind sent_status und callback_persist.
Beispielanfrage
PATCH /v1/settings/application
{
"callback_persist": true,
"sent_status": true, // Either use this or webhooks.message.sent, but webhooks.message.sent property is preferred as sent_status will be deprecated soon
"webhooks": {
"url": "webhook.your-domain",
"message": { // Available on v2.41.2 and above
"sent": false,
"delivered": true,
"read": false
},
}
}
Bei Erfolg enthält die Antwort 200 OK mit null oder ein JSON-Objekt.
Weitere Informationen zur Konfiguration deiner App und zusätzlichen Webhook-Parametern findest du in den Referenzen zu Anwendungseinstellungen.
Webhook-Benachrichtigungs-Payload
Wann immer ein Trigger-Event eintritt, nimmt die WhatsApp Business-Plattform das Event zur Kenntnis und sendet eine Benachrichtigung an die Webhook-URL, die du zuvor festgelegt hast. Du kannst zwei Arten von Benachrichtigungen erhalten:
- Empfangene Nachrichten: Diese Warnung teilt dir mit, wenn du eine Nachricht erhältst. Diese Nachrichten werden in der Dokumentation auch als „eingehende Nachrichten“ bezeichnet.
- Benachrichtigungen zum Nachrichtenstatus und der Preisgestaltung: Diese Warnung teilt dir mit, wenn sich der Status einer Nachricht ändert – z. B. die Nachricht wurde gelesen oder zugestellt. Diese Nachrichten werden in der Dokumentation auch als „ausgehende Nachrichten“ bezeichnet.
Weitere Informationen zu jedem Feld findest du unter Komponenten.
Fehlerbenachrichtigung
{
"errors": [ {
"code": <error-code>,
"title": "<error-title>",
"details": "<error-description>",
"href": "location for error detail"
},
{
...
}
]
}
Beispielapp-Endpunkte
Um deine Webhooks zu testen, kannst du eine Beispielapp mit einem Endpunkt für das Empfangen von Benachrichtigungen erstellen.
