Webhooks
Übersicht
Mit Webhooks wirst du in Echtzeit über Änderungen an den Daten deiner Abonnenten informiert. MAILINGWORK stellt Webhooks für die folgenden Ereignisse bereit:
- Anmeldung
- Abmeldung
- Profiländerung
Die zugehörigen Daten werden als JSON-String an eine Callback-URL gesendet, die POST-Requests akzeptiert.
Beispieldaten
Anmeldung erfolgreich abgeschlossen (optin_finalized)
Webhooks lassen sich in MAILINGWORK ausschließlich über die API verwaltenAPI-Funktionen
ActivateWebhook
Wird ein Webhook erstellt, ist dieser automatisch aktiv. Tritt bei der Ausführung jedoch mehrfach nacheinander ein Fehler, beispielsweise wenn die Ziel-URL nicht erreichbar ist, wird der Webhook deaktiviert. Diese Funktion erlaubt es dir, einen inaktiven Webhook zu reaktivieren.
CreateWebhook
Erstellt einen neuen Webhook und aktiviert diesen. Die Rückgabe enthält unter anderem die ID des erstellten Webhooks.
| Parameter | Beschreibung | Typ |
| username* | Benutzername | string |
| Password* | Password | string |
| app* | Name des Webhooks (für interne Zuordnung) | string |
| event* | Ereignis (optin_finalized|optout_finalized|profilemanager_finalized) | string |
| url* | URL, an die Ereignis-Daten JSON-codiert geschickt werden sollen | string |
*Pflicht
Beispiel-Aufruf
Einfacher HTTP Request - JSON Rückgabe
Rückgabe
DeleteWebHookById
Löscht den Webhook mit der angegebenen ID.
Beispiel-Aufruf
Einfacher HTTP Request - JSON Rückgabe
GetWebHooks
Listet die Webhooks auf.
Parameter | Beschreibung | Typ |
username* | Benutzername | string |
password* | Passwort | string |
advanced | Advanced-Parameter | array |
advanced[app] | Nach Name Filtern | string |
advanced[event] | Nach Event Filtern | string |
advanced[limit] | Maximale Anzahl der Einträge | int |
advanced[start] | Starte mit Eintrag | int |
*Pflicht