Webhooks

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:
  1. Anmeldung
  2. Abmeldung
  3. 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)
  1. {
        "id": 371,
        "optinsetup_id": 60,
        "subscriber_id": 6049065,
        "fields": [{
            "id": 1,
            "value": "test@example.com"
        }, {
            "id": 2,
            "value": "Herr"
        }, {
            "id": 3,
            "value": "Max"
        }, {
            "id": 4,
            "value": "Mustermann"
        }],
        "lists": [{
            "id": 1,
            "value": 1
        }, {
            "id": 3,
            "value": 0
        }],
        "activate_at": "2026-06-01 09:27:29"
    }
InfoWebhooks lassen sich in MAILINGWORK ausschließlich über die API verwalten

API-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.

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();
    curl_setopt($ch, CURLOPT_URL, 'https://webservice.sendnode.com/webservice/webservice/json/createwebhook');
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($ch, CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(
    array (
      'username' => '<USERNAME>',
      'password' => '<PASSWORD>',
      'app' => 'myApp',
      'event' => 'optin_finalized',
      'url' => '<URL>',
    )));
    $result = json_decode(curl_exec($ch), true);

    echo 'errorcode:' . $result['error'] . PHP_EOL;
    echo 'message:' . $result['message'] . PHP_EOL;
    echo 'result:' . print_r($result['result'], true) . PHP_EOL;

DeleteWebHookById

Löscht den Webhook mit der angegebenen ID.

Beispiel-Aufruf

Einfacher HTTP Request - JSON Rückgabe
  1. $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, 'https://webservice.sendnode.com/webservice/webservice/json/createwebhook');
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($ch, CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(
    array (
      'username' => '<USERNAME>',
      'password' => '<PASSWORD>',
      'app' => 'myApp',
      'event' => 'optin_finalized',
      'url' => '<URL>',
    )));
    $result = json_decode(curl_exec($ch), true);

    echo 'errorcode:' . $result['error'] . PHP_EOL;
    echo 'message:' . $result['message'] . PHP_EOL;
    echo 'result:' . print_r($result['result'], true) . PHP_EOL;


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