Documentatie
difficulty level:
API - Hook - POST hook/subscribe/{event}
Erstellen eines Webhooks durch eine externe Anwendung oder ein Framework.
POST hook/subscribe/{event}
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 überschneidet sich weitgehend mit der Basisfunktion POST.
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 | Url | booking_created |
Beispiel
Webhook registrieren.
POST api/rest/hook/subscribe/booking_updated
Request
{
"target_url": "https://hooks.zapier.com/hooks/standard/2925541/4be1a53be005409fae79c272360cf7ae/"
}
Response:
{
"id": "2",
"Location": "https://uwdomein.i-reserve.nl/api/rest/hook/3"
}
