Documentatie
difficulty level:
API - Hook - POST hook
Erstellen eines Webhooks
POST hook
Verwendet für
Erstellen eines Webhooks. Der typische Einsatz dieser API besteht im Einrichten eines sogenannten Subscription.
Die externe Anwendung kann einen Webhook dynamisch registrieren. Diese Funktion eignet sich beispielsweise für die Integrationsplattform Zapier.
Authentifizierung
Der Benutzer muss auf Administratorebene angemeldet sein.
Parameter
| Parameter | Beschreibung | Erforderlich | Ort | Beispiel |
|---|---|---|---|---|
| target_url | Die URL, an die gesendet wird | Ja | Body | https://hooks.zapier.com/hooks/standard/2925541/4be1a53be005409fae79c272360cf7ae/ |
| event | Eine Kombination aus Kontext und Event | Ja | Body | booking_created |
Beispiel
Webhook registrieren.
POST api/rest/hook/
Request
{
"target_url": "https://hooks.zapier.com/hooks/standard/2925541/4be1a53be005409fae79c272360cf7ae/",
"event": "booking_created"
}
Response:
{
"id": "2"
}
