Webhook-API ​
Alle Webhooks listen ​
GET /webhook/all
Gibt eine Liste mit den IDs aller verfĂĽgbaren Styles zurĂĽck.
Einen Webhook lesen ​
GET /webhook/:id
Beim Abrufen eines bestimmten Webhooks sind keine zusätzlichen Parameter möglich. Es wird lediglich die ID in der Anfrage-URL benötigt, um alle Daten für ein bestimmtes Element zu erhalten.
Mögliche Response ​
{
"name": "API-generierter Webhook",
"active": true,
"method": "POST",
"payload_url": "https://webhook-endpoint.your-domain.de",
"trigger": "create",
"trigger_element": "rsvp_answer",
"header": [
{
"key": "secret",
"value": "f7n4wzvn$7t84owz%vc!4wort73"
}
],
"body": [],
"date_created": "2025-04-08T12:50:05.756Z",
"date_updated": null,
"last_execution": "2025-05-01T02:33:08.356Z"
}
Webhook erstellen ​
POST /webhook
FĂĽr die Erstellung eines neuen Webhooks mĂĽssen die meisten Felder angegeben werden. Nur body
und header
sind optional!
Möglicher Request mit allen Feldern ​
{
"name": "API-generierter Webhook", // nur intern
"active": true, // wenn false, wird er nicht ausgelöst
"method": "POST", // Optionen: GET, POST, PUT, PATCH, DELETE
"payload_url": "https://webhook-endpoint.your-domain.de", // der Endpunkt, an den wir die Daten senden
"trigger": "create", // Optionen: create, update, delete
"trigger_element": "rsvp_answer", // Optionen: rsvp_answer, event, event_group, style, rsvp_template, cta_template, landingpage_template
"header": [ // zusätzliche Felder, die dem Header hinzugefügt werden (normalerweise ein Authentifizierungstoken)
{
"key": "secret",
"value": "f7n4wzvn$7t84owz%vc!4wort73"
}
],
"body": [ // zusätzliche Body-Felder zum Senden
{
"key": "additional-body-field",
"value": "some value"
}
]
}
Body anpassen
Standardmäßig senden wir alle Daten des Trigger-Elements als JSON-Objekt mit dem Schlüssel "element_data".
Du kannst auch deine eigenen Felder definieren und einzelne Felder als Wert verwenden, indem du sie dem Body hinzufĂĽgst. Dort kannst du dynamische Werte hinzufĂĽgen, indem du sie in doppelten geschweiften Klammern einfĂĽgst. ĂśberprĂĽfe die Web-App fĂĽr weitere Details, welche Felder fĂĽr welches trigger_element
verfĂĽgbar sind.
Mögliche Response ​
{
"success": "Webhook created",
"id": "67"
}
Teste es
Du kannst die Web-App verwenden, um einen Testaufruf mit einigen generischen Testdaten zu senden. Du kannst zusätzlich Dienste wie webhook.site nutzen, um den Flow zu testen, bevor du ihn an dein eigenes System anbindest.
Webhook aktualisieren ​
PATCH /webhook/:id
Die Aktualisierung eines Webhooks folgt denselben Regeln wie die Erstellung eines neuen.
Webhook löschen ​
DELETE /webhook/:id
Das Löschen eines Webhooks ist einfach. Gib hierzu lediglich die ID an, und er wird entfernt.
Sei bei diesem Aufruf sehr vorsichtig, da dies die entsprechende Funktionalität sofort entfernt!