Documentatie

Aanmaken van een webhook

POST hook

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 is bijvoorbeeld geschikt voor het integratie platform Zapier.

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 Body booking_created

Voorbeeld

Registreren webhook.

POST api/rest/hook/ 
Request
{
  "target_url": "https://hooks.zapier.com/hooks/standard/2925541/4be1a53be005409fae79c272360cf7ae/",
  "event": "booking_created"
}
Response: 
{
    "id": "2"
}

Onderstaand recht kan nodig zijn om deze functionaliteit te kunnen gebruiken.