Documentatie

Aanmaken van een webhook door externe applicatie of framework.

POST hook/subscribe/{event}

Gebruikt voor

Aanmaken van een webhook. Het typisch gebruik van deze API is voor het opzetten van een zogenaamde subscription.
De externe applicatie kan een webhook dynamisch registreren.
Deze functie heeft een grote overlap met de basis functie POST.

Authenticatie

Gebruiker dient ingelogd te zijn op beheerdersniveau.

Parameters

Parameter Omschrijving Verplicht Locatie Voorbeeld
target_url De URL om naar te posten Yes Body https://hooks.zapier.com/hooks/standard/2925541/4be1a53be005409fae79c272360cf7ae/
event Een combinatie van context en event Yes Url booking_created

Voorbeeld

Registreren webhook.

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"
}
Onderstaand recht kan nodig zijn om deze functionaliteit te kunnen gebruiken.