Zum Hauptinhalt springen
Webhooks bieten Echtzeit-Benachrichtigungen für Ereignisse wie Kampagnenerstellung, -aktualisierung oder -löschung. Um diese Benachrichtigungen zu erhalten, müssen Sie eine öffentlich zugängliche URL angeben, die HTTP POST-Anfragen empfangen kann.

​
Wie es funktioniert

Wenn ein Ereignis eintritt, wird eine HTTP POST-Anfrage mit den Ereignisdetails an Ihre angegebene URL gesendet. Ihre URL muss einen HTTP 2xx-Statuscode für erfolgreiche Anfragen zurückgeben.
Webhooks werden über die Create Webhook API erstellt, wo Sie das auslösende Ereignis mit dem Kanalfeld definieren. Ein einzelner Webhook ist pro Kanal erlaubt.

​
Wiederholungsversuche und Validierung

Wenn Ihre Webhook-URL nicht erreichbar ist, versuchen wir, die Anfrage bis zu 5 Mal innerhalb von 1 Minute zu wiederholen, wobei wir exponentielles Backoff verwenden. Wiederholungen erfolgen nur bei HTTP 5xx- oder 429-Statuscodes.
Um die Authentizität und Integrität von Webhook-Zustellungen zu gewährleisten, müssen Sie die Signatur validieren. Topsort generiert eine Signatur unter Verwendung Ihres Webhook-Secrets und der Ereignis-Payload und fügt sie in den HTTP-Header X-TS-Signature-256 ein.
Sie können Ihr Webhook-Secret bei der Erstellung festlegen; andernfalls wird eines generiert. Bewahren Sie Ihr Secret sicher auf.
Topsort verwendet den HMAC-Hex-Digest (beginnend mit sha256=), um die Signatur zu berechnen. Sie müssen den Hash auf Ihrem Server neu berechnen und mit dem X-TS-Signature-256-Header vergleichen, um die Signatur zu verifizieren.

​
Beispiel für Signaturverifizierung

import hmac
import hashlib

secret = "my-webhook-secret"
request = ... # eingehende Anfrage von Webhook-Zustellung

signature = hmac.new(
    key=secret.encode(),
    msg=await request.body(),
    digestmod=hashlib.sha256,
).hexdigest()

expected_signature = "sha256=" + signature
incoming_signature = request.headers["X-TS-Signature-256"]

if not hmac.compare_digest(incoming_signature, expected_signature):
    # Signatur ist ungültig, Zustellung nicht verarbeiten
else:
    # Signatur ist gültig, Zustellung verarbeiten
Zuletzt aktualisiert: