WebHooks

Ein Webhook ist ein Mechanismus, mit dem EngageLab Daten zu bestimmten E-Mail-Events, für die Kund:innen sich interessieren, asynchron an die Callback-URL der Kund:innen sendet.

Über die REST API können Sie Callback-URLs für Ihre E-Mail-Events abfragen, hinzufügen, aktualisieren und löschen. Damit optimieren Sie Ihre Prozesse und steigern die Effizienz Ihrer E-Mail-Kommunikation.

Aufrufadresse

Rechenzentrum	URL
Singapur	https://email.api.engagelab.cc
Türkei	https://emailapi-tr.engagelab.com

Beim Einsatz der REST API stellen Sie sicher, dass das gewählte Rechenzentrum zur entsprechenden Basis-URL passt.

Callback-URLs abfragen

URL

https://email.api.engagelab.cc/v1/webhooks

              
              https://email.api.engagelab.cc/v1/webhooks

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Request-Methode

GET

GET

Diesen Codeblock im schwebenden Fenster anzeigen

Header

Header	Typ	Erforderlich	Beschreibung
Authorization	string	ja	Basic base64(api_user:api_key)

Beschreibung der Query-Parameter

Parameter	Typ	Erforderlich	Beschreibung
api_user	string	nein	Zugehöriger API_USER
offset	int	nein	Startposition, [0-], Standardwert ist 0
limit	int	nein	Anzahl, [0-100], Standardwert ist 100

Beispiel für eine Anfrage:

curl -X GET -H 'Content-Type: application/json; charset=utf-8' \ -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \ 'https://email.api.engagelab.cc/v1/webhooks?api_user=abcd&offset=0&limit=1'

              
              curl -X GET -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
     'https://email.api.engagelab.cc/v1/webhooks?api_user=abcd&offset=0&limit=1'

Diesen Codeblock im schwebenden Fenster anzeigen

Beispiel für eine Rückgabe:

{ "result": [ { "url": "http://qxxx.com", "event": [1,3], "api_user": "my_test", "id":168 } ], "count":1, "total":2 }

              
              {
    "result": [
        {
            "url": "http://qxxx.com",
            "event": [1,3],
            "api_user": "my_test",
            "id":168
        }
    ],
    "count":1,
    "total":2
}

Diesen Codeblock im schwebenden Fenster anzeigen

Callback-URL hinzufügen

URL

https://email.api.engagelab.cc/v1/webhooks

              
              https://email.api.engagelab.cc/v1/webhooks

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Request-Methode

POST

              
              POST

Diesen Codeblock im schwebenden Fenster anzeigen

Header

Header	Typ	Erforderlich	Beschreibung
Authorization	string	ja	Basic base64(api_user:api_key)

Beschreibung der Body-Parameter

Parameter	Typ	Erforderlich	Beschreibung
url	string	ja	Geben Sie die Callback-URL an, an die der Event-Webhook die Eventdaten sendet.
api_user	string	nein	Zugehöriger API_USER, Standardwert: alle api_users
event	array	nein	Event-Typen, z. B. [1,3]. Standardwert: alle Events.

Parameterbeschreibung allgemeiner E-Mail-Events

Parameter	Event	Auslöser-Bedingung
1	deliver	Die E-Mail wurde erfolgreich zugestellt
3	report_spam	Nutzer:in meldet E-Mail als Spam
4	invalid_email	Die Nachricht konnte nicht erfolgreich gesendet werden
5	soft_bounce	Empfänger:in lehnt die Nachricht ab
10	click	Nutzer:in klickt auf einen Link
11	open	Nutzer:in öffnet die E-Mail
12	unsubscribe	Nutzer:in meldet sich vom E-Mail-Empfang ab
18	request	Die E-Mail-Anfrage war erfolgreich, inkl. gesendeter und sendender E-Mails
32	sent	Die E-Mail wurde erfolgreich gesendet

Beispiel für eine Anfrage:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' \ -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \ --data '{"url": "123456","api_user":"qq.com", "event":[1,3]}' \ 'https://email.api.engagelab.cc/v1/webhooks'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
     --data '{"url": "123456","api_user":"qq.com", "event":[1,3]}' \
     'https://email.api.engagelab.cc/v1/webhooks'

Diesen Codeblock im schwebenden Fenster anzeigen

Beispiel für eine Rückgabe:

{ "result": [ { "url": "http://qxxx.com", "event": [1,3], "api_user": "my_test", "id":167 } ] }

              
              {
    "result": [
        {
            "url": "http://qxxx.com",
            "event": [1,3],
            "api_user": "my_test",
            "id":167
        }
    ]
}

Diesen Codeblock im schwebenden Fenster anzeigen

Callback-URL bearbeiten

URL

https://email.api.engagelab.cc/v1/webhooks/{id}

              
              https://email.api.engagelab.cc/v1/webhooks/{id}

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Request-Methode

PUT

PUT

Diesen Codeblock im schwebenden Fenster anzeigen

Header

Header	Typ	Erforderlich	Beschreibung
Authorization	string	ja	Basic base64(api_user:api_key)

Beschreibung der Body-Parameter

Parameter	Typ	Erforderlich	Beschreibung
url	string	nein	Neue Callback-URL; wenn kein Parameter übergeben wird, bleibt die Einstellung unverändert.
api_user	string	nein	Zugehöriger API_USER; wenn kein Parameter übergeben wird, bleibt die Einstellung unverändert.
event	array	nein	Event-Typen, z. B. [1,3]; wenn kein Parameter übergeben wird, bleibt die Einstellung unverändert.

Beispiel für eine Anfrage:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' \ -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \ --data '{"url": "http://example2.com"}' \ 'https://email.api.engagelab.cc/v1/webhooks/1111111'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
     --data '{"url": "http://example2.com"}' \
     'https://email.api.engagelab.cc/v1/webhooks/1111111'

Diesen Codeblock im schwebenden Fenster anzeigen

Beispiel für eine Rückgabe:

{ "count":1 }

              
              {
   "count":1
}

Diesen Codeblock im schwebenden Fenster anzeigen

Callback-URL löschen

URL

https://email.api.engagelab.cc/v1/webhooks/{id}

              
              https://email.api.engagelab.cc/v1/webhooks/{id}

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Request-Methode

DELETE

              
              DELETE

Diesen Codeblock im schwebenden Fenster anzeigen

Header

Header	Typ	Erforderlich	Beschreibung
Authorization	string	ja	Basic base64(api_user:api_key)

Beispiel für eine Anfrage:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \ -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \ 'https://email.api.engagelab.cc/v1/webhooks/1111111'

              
              curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
     'https://email.api.engagelab.cc/v1/webhooks/1111111'

Diesen Codeblock im schwebenden Fenster anzeigen

Beispiel für eine Rückgabe:

{ "count":1 }

              
              {
    "count":1
}

Diesen Codeblock im schwebenden Fenster anzeigen

Tipp: Nutzen Sie die EngageLab Webhook API, um Ihre E-Mail-Events zuverlässig und effizient zu überwachen und Ihre Prozesse zu automatisieren.