Webhooks

Webhooks

Mit Webhooks wirst du in Echtzeit über Änderungen an den Daten deiner Abonnenten informiert. MAILINGWORK bietet dir dafür Webhooks für die folgenden Ereignisse an:
  1. Anmeldung
  2. Abmeldung
  3. Profiländerung
Die zum Ereignis gehörigen Daten werden als JSON-String an eine Callback-URL gesendet, welche POST-Requests akzeptiert.

Info
Webhooks lassen sich in MAILINGWORK ausschließlich über die API verwalten.

Beispieldaten
Anmeldung erfolgreich abgeschlossen (optin_finalized)
  1. {
  2.     "id": 371,
  3.     "optinsetup_id": 60,
  4.     "subscriber_id": 6049065,
  5.     "fields": [{
  6.         "id": 1,
  7.         "value": "max.muster@example.com"
  8.     }, {
  9.         "id": 2,
  10.         "value": "Herr"
  11.     }, {
  12.         "id": 3,
  13.         "value": "Max"
  14.     }, {
  15.         "id": 4,
  16.         "value": "Muster"
  17.     }],
  18.     "lists": [{
  19.         "id": 1,
  20.         "value": 1
  21.     }, {
  22.         "id": 3,
  23.         "value": 0
  24.     }, {
  25.         "id": 5,
  26.         "value": 0
  27.     }],
  28.     "activate_at": "2025-11-11 09:27:29"
  29. }

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.

ParameterBeschreibung
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
  1. $ch = curl_init();
  2. curl_setopt($ch, CURLOPT_URL, 'https://webservice.sendnode.com/webservice/webservice/json/createwebhook');
  3. curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
  4. curl_setopt($ch, CURLOPT_POST, 1);
  5. curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(
  6. array (
  7.   'username' => '<Benutzername>',
  8.   'password' => '<Password>',
  9.   'app' => 'newsletter-optin',
  10.   'event' => 'optin_finalized',
  11.   'url' => 'https://example.com/foo.php',
  12. )));
  13. $result = json_decode(curl_exec($ch), true);

Rückgabe
  1. {
  2.     "error": 0,
  3.     "message": "successfully executed",
  4.     "result": {
  5.         "id": 5,
  6.         "app": "newsletter-optin",
  7.         "event": "optin_finalized",
  8.         "url": "https:\/\/example.com\/foo.php"
  9.     }
  10. }

DeleteWebHookById

GetWebHooks


Tabelle
Beschreibung
add
Hinzufügen
replace
Ersetzen
update
Aktualisieren
update_add
Aktualisieren und Hinzufügen (empfohlen)
update_intersect
Aktualisieren - fehlende Empfänger aus Liste löschen
update_add_intersect
Aktualisieren und Hinzufügen - fehlende Empfänger aus Liste löschen