Hoe kan een applicatie een webhook aanmelden?

Een webhook kan door de beheerder gemaakt worden of kan - via de API - worden aangevraagd door een andere applicatie.

Aanvragen via de API

Er zijn enkele methodes waarmee een applicatie een webhook kan registreren.
Er dient sprake te zijn van een geldige connectie. Hiervoor wordt Oauth 2.0 aanbevolen.

Als er sprake is van een geldige connectie èn de gebruiker heeft de juiste rechten, dan kan een applicatie een webhook registreren.
Meestal zal er sprake zijn van een unieke - applicatie specifieke - URL.
De applicatie geeft hiermee aan i-Reserve aan op welke locatie de gegevens afgeleverd worden.
De applicatie kan via de API de webhook ook verwijderen. De methodes in de API die van toepassing zijn:

• POST hook
• POST hook/subscribe/{event}
• DELETE hook/{id}

De twee methodes om een webhook aan te melden zijn verschillend maar leveren hetzelfde resultaat op.
Dit heeft te maken met gangbare methodes die integratieplatformen gebruiken.

Voorbeeld integratie

Zapier is een voorbeeld van een integratieplatform welke via webhooks integraties uitvoert.
De termen die dit platform gebruikt zijn zaps, die bestaan uit triggers en actions.
Een triggers in i-Reserve is "Booking Created" die plaats vindt als een reservering in i-Reserve wordt gemaakt.
In de Zapier instellingen dient deze trigger te worden aangemaakt.
In de trigger settings is een mogelijkheid voor het opgeven van een "REST Hook Subscribe URL".
Hier wordt opgegeven "https://{{endpoint}}/api/rest/hook/" waarbij {{endpoint}} de basis URL is van de i-Reserve omgeving.
Op het moment dat Zapier een Zap activeert zal een POST worden gedaan naar de hook methode.
Met als event "booking_created" en target_url: "https://hooks.zapier.com/hooks/standard/2925541/4be1a53be005409fae79c272360cf7ae/"
Vanaf dat moment worden reserveringen gepushed naar de target_url.
Zapier kan daarmee een actie naar een andere applicatie uitvoeren.
.