Webhooks

Um diese Funktion freizuschalten, wenden Sie sich an die Kundenbetreuung.

Dieses Kapitel beschreibt, wie Sie mit Webhooks HTTP-Callback zur Übermittlung von Ereignisdaten in Echtzeit. Echtzeit-Ereignisdaten zu Ihren Mailings erhalten. Sie können Webhooks für folgende Ereignisse erstellen:

versendete Mailings
Öffnungen
Klicks
Bounces
Abbestellungen
Spam-Beschwerden

Die Daten können Sie beispielsweise für Benachrichtigungen und Analysen in externen Systemen wie CRM Steht für „Customer Relationship Management“. Ein System zur Verwaltung des aktuellen und zukünftigen Kundenverkehrs, inklusive Support für Vertrieb, Marketing, Kundenservice und Technischer Service.-Software verwenden. Webhooks verwalten Sie mithilfe der Optimizely Campaign REST-API.

Webhooks erstellen

Webhooks abrufen

Webhooks aktualisieren

Webhooks verifizieren

Webhooks aktivieren

Webhooks deaktivieren

Webhooks löschen

Webhooks erstellen

Öffnen Sie die Operation Create a webhook und klicken Sie auf Try it out.
Geben Sie in den folgenden Pflichtfeldern die entsprechenden Informationen ein:
- clientId. Mandanten-ID. Die Mandanten-ID finden Sie in Optimizely Campaign unter Verwaltung > API-Übersicht > REST-API.
- targetUrl. URL Steht für „Uniform Resource Locator“ (Internetadresse). Auch bekannt als Webadresse wie http://world.optimizely.com., an die die Ereignisdaten gesendet werden sollen.
  Voraussetzungen:
  - URL muss erreichbar sein und zu jeder Zeit Daten mittels HTTP-POST-Anfragen der IP-Adresse 193.169.180.1 empfangen können
  - aktuelle HTTPS-Version und Standard-Port 443 für HTTPS-Verbindungen
- type. Art der Ereignisdaten, die gesendet werden sollen.
  - open. Mailing geöffnet.
  - click. Links geklickt.
  - sent. Mailing versendet.
  - bounce. Hard Hard-Bounces treten auf, wenn eine E-Mail aufgrund eines dauerhaften Fehlers nicht zugestellt werden kann (z.B. weil die E-Mail-Adresse nicht mehr existiert).- oder Soft-Bounce Soft-Bounces treten auf, wenn E-Mails aufgrund vorübergehender Probleme nicht zugestellt werden können. Dies kann z. B. der Fall sein, wenn der Posteingang eines Empfängers voll ist. Posteingänge, die Mails per Soft-Bounce ablehnen, können zu einem späteren Zeitpunkt wieder verfügbar sein. erzeugt.
  - unsubscribe. Newsletter abbestellt. Siehe auch Abbesteller.
  - spamcomplaint. Nachricht als Spam markiert.
- format. Datenformat, in dem die Ereignisdaten versendet werden sollen.
  Derzeit ist folgendes Datenformat verfügbar: JSON.
Geben Sie optional folgende Informationen ein, wenn Sie den Basic-HTTP-Authentifizierungsheader übermitteln möchten:
- basicAuthUsername. Benutzername.
- basicAuthPassword. Passwort.
Klicken Sie auf Execute. Bei erfolgreicher Erstellung erhalten Sie als API-Antwort den HTTP-Statuscode 201.

Webhook-Informationen abrufen

Um Informationen über einen Webhook abzurufen, wie zum Beispiel Webhook ID, Ziel-URL und Eventtyp, gehen sie wie folgt vor:

Öffnen Sie die Operation Get information about all webhooks und klicken Sie auf Try it out.
Geben Sie im Pflichtfeld clientId Ihre Mandanten-ID ein. Die Mandanten-ID finden Sie im Optimizely Campaign Menü unter Verwaltung > API-Übersicht > REST-API.
Klicken Sie auf Execute.

Sie benötigen die Webhook-ID, um den Webhook zu aktualisieren, verifizieren, aktivieren, deaktivieren und zu löschen.

Webhooks aktualisieren

Öffnen Sie die Operation Update a webhook und klicken Sie auf Try it out.
Geben Sie in den folgenden Pflichtfeldern die entsprechenden Informationen ein:
- clientId. Ihre Mandanten-ID. Die Mandanten-ID finden Sie im Optimizely Campaign Menü unter Verwaltung > API-Übersicht > REST-API.
- webhookId. Webhook-ID. Die Webhook-ID können Sie mit der Operation Get information about all webhooks abfragen.
Aktualisieren Sie die Informationen wie unter Webhooks erstellen beschrieben.
Klicken Sie auf Execute.

Webhooks verifizieren

Um zu überprüfen, ob der Webhook einsatzbereit ist und Ereignisdaten an die angegebene URL Steht für „Uniform Resource Locator“ (Internetadresse). Auch bekannt als Webadresse wie http://world.optimizely.com. senden kann, gehen Sie wie folgt vor:

Öffnen Sie die Operation Verify a webhook und klicken Sie auf Try it out.
Geben Sie folgende Informationen ein:
- clientId. Ihre Mandanten-ID. Die Mandanten-ID finden Sie im Optimizely Campaign Menü unter Verwaltung > API-Übersicht > REST-API.
- webhookId. Webhook-ID. Die Webhook-ID können Sie mit der Operation Get information about all webhooks abfragen.
- mailingId. ID eines gültigen Mailings, zum Beispiel ein Test-Mailing in Smart Campaigns.
Klicken Sie auf Execute.

Webhooks aktivieren

Um Ereignisdaten in Echtzeit zu exportieren, müssen Sie den entsprechenden Webhook aktivieren. Gehen Sie wie folgt vor:

Öffnen Sie die Operation Activate a webhook und klicken Sie auf Try it out.
Geben Sie in den folgenden Pflichtfeldern die entsprechenden Informationen ein:
- clientId. Ihre Mandanten-ID. Die Mandanten-ID finden Sie im Optimizely Campaign Menü unter Verwaltung > API-Übersicht > REST-API.
- webhookId. Webhook-ID. Die Webhook-ID können Sie mit der Operation Get information about all webhooks abfragen.
Klicken Sie auf Execute.

Ereignisdaten

Sobald ein Mailing-Empfänger eine Aktion ausführt, sendet Optimizely Campaign eine HTTP-POST-Anfrage mit den entsprechenden Ereignisdaten an die Ziel-URL. Die Ereignisdaten werden in Datenpaketen (Listen) bestehend aus jeweils maximal 100 Ereignissen versendet.

Nach erfolgreichem Datenempfang muss die Ziel-URL den HTTP-Statuscode 200 zurückgeben. Andernfalls wird der Export alle 10 Sekunden wiederholt. Wenn nach drei Tagen ab Erstellung des Ereignisses keine Daten zugestellt werden können, wird das Ereignis verworfen.

—Beispiel: Liste mit Ereignisdaten (Öffnungen) im JSON-Format—

[
  {
    "type":"open",
    "recipientId":"123456789005",
    "userListId":123456789003,
    "remoteAddress":"10.420.3.42",
    "clientId":123456789001,
    "mailingId":123456789004,
    "created":1564590054000,
    "subscriptionId":1234567,
    "mailId":"3P5W8B4-3P5W0LI-BSLXEC",
    "mediaTypesToAddresses": {
      "EMAIL":"[email protected]"
    },
    "device":"desktop",
    "operatingSystem":"Windows 10",
    "browser":"Firefox 64.1"
  },
  {
    "type":"open",
    "recipientId":"123456789005",
    "userListId":123456789003,
    "remoteAddress":"10.420.3.42",
    "clientId":123456789001,
    "mailingId":123456789004,
    "created":1564590054000,
    "subscriptionId":1234567,
    "mailId":"4P6W8B4-4P6W0LI-BSLXEC",
    "mediaTypesToAddresses": {
      "EMAIL":"[email protected]"
    },
    "device":"desktop",
    "operatingSystem":"Windows 10",
    "browser":"Firefox 64.1"
  }
]

—Beispiel: Ereignisdaten (Klicks) im JSON-Format—

{
    "type":"click",
    "link":"https://www.optimizley.com",
    "mailingId":10230355206,
    "remoteAddress":"10.420.3.42",
    "linkId":10180855027,
    "device":"desktop",
    "browser":"Safari 13.1",
    "operatingSystem":"Mac 10.13",
    "created":1617108763000,
    "mailId":"4P6W8B4-4P6W0LI-BSLXEC",
    "mediaTypesToAddresses": {
      "EMAIL":"[email protected]"
    },
    "userListId":10180860004,
    "recipientId":"[email protected]",
    "subscriptionId":10227900201,
    "clientId":10180860001
}

—Beispiel: Ereignisdaten (versendete Mailings) im JSON-Format—

{
    "mailingType":"campaign",
    "type":"sent",
    "id":"0a673110-17883138caf-178832ea49f-2690c03e51f4cc26",
    "mailingId":10230355206,
    "mediaType":"EMAIL",
    "mailingName":"Welcome",
    "created":1617108575391,
    "mailId":"4P6W8B4-4P6W0LI-BSLXEC",
    "mediaTypesToAddresses": {
      "EMAIL":"[email protected]"
    },
    "userListId":10180860004,
    "recipientId":"[email protected]",
    "subscriptionId":10227900201,
    "clientId":10180860001
}

—Beispiel: Ereignisdaten (Bounce) im JSON-Format—

{
    "type":"bounce",
    "id":"0a673102-178d27b2c8c-178d2cac0e4-c7420699923845e",
    "recipientId":"[email protected]",
    "userListId":10180860004,
    "clientId":10180860001,
    "created":1617108575391,
    "subscriptionId":10227900201,
    "mailId":"4P6W8B4-4P6W0LI-BSLXEC",
    "mailingId":10230355206,
    "mediaTypesToAddresses": {
      "EMAIL":"[email protected]"
    },
    "category":"softbounce",
    "mediaType":"EMAIL",
    "reason":"other",
    "thresholdExceeded":false
}

Der Parameter "category" gibt die Bounce-Kategorie an; "softbounce" oder "hardbounce". Der Parameter "reason" gibt den Bounce-Grund an; Spam ("spam-related") oder alle anderen ("other"). Der Parameter "thresholdExceeded" gibt an, ob der Empfänger das Bounce-Limit überschritten hat.

—Beispiel: Ereignisdaten (Abbestellung) im JSON-Format—

{
    "type":"unsubscribe",
    "reason":"Unsubscribe via REST API",
    "id":"0acb3115-17aa6042099-17aaa1c69bf-6efb42209c0b1",
    "mailingId":10230355205,
    "mediaTypesToAddresses": {
      "EMAIL":"[email protected]"
    },
    "mediaType":"EMAIL",
    "subscriptionId":10237984200,
    "mailId":"4P6W7B7-4P5W0LI-BALXEC",
    "created":1617108763000,
    "recipientId":"[email protected]",
    "userListId":10180860009,
    "clientId":10180860001,
}

—Beispiel: Ereignisdaten (Spam-Beschwerde) im JSON-Format—

{
    "mailingType": "campaign",
    "providerName": "AOL",
    "id": "0a0a3742-17k7f11690c-13c82b66689-63eb542f53667a61",
    "mailingId": 365704742069,
    "type":"spamcomplaint",
    "mediaTypesToAddresses": {
      "EMAIL":"[email protected]"
    },
    "subscriptionId":10237984200,
    "mailId":"4P6W7B7-4P5W0LI-BALXEC",
    "created":1617108763000,
    "userListId":10180860009,
    "recipientId":"[email protected]",
    "clientId":10180860001,
}

Webhooks deaktivieren

Wenn Sie keine Ereignisdaten mehr exportieren möchten, müssen Sie den Webhook deaktivieren. Der Webhook existiert weiterhin und Sie können ihn später reaktivieren. Gehen Sie wie folgt vor:

Öffnen Sie die Operation Deactivate a webhook und klicken Sie auf Try it out.
Geben Sie in den folgenden Pflichtfeldern die entsprechenden Informationen ein:
- clientId. Ihre Mandanten-ID. Die Mandanten-ID finden Sie im Optimizely Campaign Menü unter Verwaltung > API-Übersicht > REST-API.
- webhookId. Webhook-ID. Die Webhook-ID können Sie mit der Operation Get information about all webhooks abfragen.
Klicken Sie auf Execute.

Webhooks löschen

Wenn Sie beispielsweise einen Webhook nicht mehr benötigen oder neue Webhooks erstellen wollen, aber das Erstellungslimit pro Mandant erreicht ist, können Sie Webhooks löschen. Gehen Sie wie folgt vor:

Sie können nur deaktivierte Webhooks löschen. Siehe Webhook deaktivieren.

Öffnen Sie die Operation Delete a webhook und klicken Sie auf Try it out.
Geben Sie in den folgenden Pflichtfeldern die entsprechenden Informationen ein:
- clientId. Ihre Mandanten-ID. Die Mandanten-ID finden Sie im Optimizely Campaign Menü unter Verwaltung > API-Übersicht > REST-API.
- webhookId. Webhook-ID. Die Webhook-ID können Sie mit der Operation Get information about all webhooks abfragen.
Klicken Sie auf Execute.