Webhooks
Webhooks ermoeglichen es Ihnen, HTTP-Callbacks in Echtzeit zu empfangen, wenn Ereignisse auf Ihren WhatsApp-Instanzen auftreten. Anstatt die API abzufragen, sendet Wappfy Ereignisse an Ihren Server, sobald sie eintreten.Unterstuetzte Ereignisse
Wappfy unterstuetzt 12 Webhook-Ereignistypen:Nachrichtenereignisse
Nachrichtenereignisse
Instanz-Ereignisse
Instanz-Ereignisse
Gruppen- & Kontakt-Ereignisse
Gruppen- & Kontakt-Ereignisse
Webhook erstellen
Registrieren Sie einen Webhook-Endpunkt, um Ereignisse zu empfangen.Konfigurationsoptionen
Das Feld
instance_id ist optional. Wenn es weggelassen wird, empfaengt der Webhook Ereignisse von allen Instanzen in Ihrem Konto.Webhooks auflisten
Webhook aktualisieren
Aktualisieren Sie die URL, Ereignisse oder Konfiguration eines bestehenden Webhooks.Webhook loeschen
Zustellungs-Payload-Format
Wenn ein Ereignis eintritt, sendet Wappfy eine POST-Anfrage an Ihre Webhook-URL mit folgender Struktur:Payload-Felder
HMAC-Signaturverifizierung
Wenn Sie beim Erstellen eines Webhooks einsecret angeben, enthaelt jede Zustellung einen X-Wappfy-Signature-Header mit einer HMAC-SHA256-Signatur des Anfrageinhalts.
Verifizieren Sie diese Signatur immer, um sicherzustellen, dass die Anfrage von Wappfy stammt und nicht manipuliert wurde.
Verifizierungsbeispiele
Wiederholungsverhalten
Wenn Ihr Server nicht innerhalb der konfiguriertentimeout_ms mit einem 2xx-Statuscode antwortet, wiederholt Wappfy die Zustellung.
Wiederholungen werden gestoppt, wenn eine
2xx-Antwort empfangen wird oder die retry_count-Anzahl erschoepft ist. Der Standard-Wiederholungszaehler betraegt 3.Zustellungsverlauf einsehen
Pruefen Sie das Zustellungsprotokoll eines Webhooks, um vergangene Zustellungsversuche und deren Ergebnisse einzusehen.Beispiele fuer Ereignis-Payloads
message.received
message.received
message.delivered
message.delivered
message.read
message.read
message.reaction
message.reaction
instance.connected
instance.connected
instance.qr
instance.qr
group.joined
group.joined
Best Practices
Schnell antworten
Geben Sie innerhalb von 5 Sekunden einen
200-Status zurueck. Verarbeiten Sie das Ereignis asynchron, um Timeouts zu vermeiden.Deduplizieren
Verwenden Sie die Zustellungs-
id, um doppelte Zustellungen durch Wiederholungen zu erkennen und zu ueberspringen.Signaturen verifizieren
Validieren Sie immer den
X-Wappfy-Signature-Header, wenn Sie ein Geheimnis konfiguriert haben.HTTPS verwenden
Webhook-URLs muessen HTTPS verwenden. HTTP-Endpunkte werden abgelehnt.