Webhooks zijn op HTTPS gebaseerde terugkoppelingsmechanismen (callbacks) voor web-API's. Bij Briq maken ze het mogelijk dat externe partijen via een HTTPS-verzoek een melding ontvangen wanneer bepaalde gebeurtenissen (zogenaamde webhooks) plaatsvinden.
Een eenvoudig voorbeeld hiervan is het aanmaken van een reservering. Via webhooks kunnen externe partijen zich abonneren op deze gebeurtenis ('Booking.Create'). Telkens wanneer er een nieuwe reservering wordt aangemaakt, ontvangen zij automatisch een HTTPS-verzoek op een vooraf ingestelde URL, met vooraf bepaalde headers en inhoud van het bericht (body).
Een webhook verwijst zowel naar de gebeurtenis als naar de daadwerkelijke terugkoppeling (of een reeks terugkoppelingen). Webhooks hebben een naam (bijvoorbeeld 'BookingUpdated' of 'BookingExpired') en een payload. De payload bevat de contextuele gegevens die bij de betreffende gebeurtenis horen. Bij een 'Booking.Updated'-webhook zijn dit bijvoorbeeld de reserveringsgegevens en bij een 'CustomerUpdated'-webhook de klantgegevens.
Telkens wanneer de betreffende gebeurtenis plaatsvindt, wordt de webhook geactiveerd. Dit betekent dat het webhook-framework begint met het verwerken van de gebeurtenis en de bijbehorende payload.
Supported Webhooks
| Booking Events | Description |
|---|---|
| Booking.Created | Triggered when a new booking is created. |
| Booking.Updated | Triggered every time a booking is updated. |
| Booking.StatusUpdated | Triggered when a booking status changes. (Example from Pending to Active or Error) |
| Booking.Deleted | Triggered when a booking is deleted. |
| Booking.Executed | Triggered when a booking has been executed. |
| Booking.Expired | Triggered when a booking expires. |
| Booking.Cancelled | Triggered when a booking status turns to Cancelled. |
| Booking.Reminder | Send a message X hours before check-in time to remind a consumer about a booking. |
| Booking.DayOfVisit | Sync a calendar on the morning with all the bookings of that day. |
| Booking.CheckIn | Triggered when attendance is switched to CheckedIn. |
| Booking.Evaluation | Triggered when attendance is switched to CheckedIn. |
| Booking.Placed | Triggered when a booking is placed. |
| Product Events | Description |
|---|---|
| Product.Created | Triggered when a new product is created. |
| Product.Updated | Triggered every time a product is updated. |
| Product.Deleted | Triggered every time a product is deleted. |
| Resource Events | Description |
|---|---|
| Resource.Created | Triggered when a new resource is created. |
| Resource.Updated | Triggered every time a resource is updated. |
| Deal Events | Description |
|---|---|
| Deal.Created | Triggered when a new deal is created. |
| Deal.Updated | Triggered every time a deal is updated. |
De eerste webhookmelding wordt direct verzonden nadat de gebeurtenis heeft plaatsgevonden. We hebben een mechanisme voor nieuwe pogingen (retries). Als bij de eerste poging geen 200 OK-status wordt ontvangen, proberen we de melding op een later moment opnieuw te verzenden.
Volgens ons retrybeleid proberen we de webhook nog 4 keer extra te verzenden, waarbij de tussenpozen tussen de pogingen steeds langer worden.
Als we na de vijfde poging nog steeds geen 200 OK-respons ontvangen (na in totaal 60 minuten), stoppen we met het opnieuw verzenden. De webhook krijgt dan de status Failed (Mislukt).
| Attempt | Interval |
|---|---|
| 1st | Immediately after event is triggered. |
| 2nd | 1 minute |
| 3rd | 5 minutes |
| 4th | 15 minutes |
| 5th | 60 minutes |
De configuratie van de webhooks vindt plaats in briq.app. Voor elk evenement waarvan je meldingen wilt ontvangen, moet je een geldige URL instellen.
Neem contact op met ons team. Zij helpen je graag bij het configureren van de webhooks.
Was dit artikel nuttig?
Dat is fantastisch!
Hartelijk dank voor uw beoordeling
Sorry dat we u niet konden helpen
Hartelijk dank voor uw beoordeling
Feedback verzonden
We stellen uw moeite op prijs en zullen proberen het artikel te verbeteren