Webhooks are HTTPS based callback mechanisms for web APIs. In Briq, they allow third parties to be notified by a HTTPS call when certain events (called webhooks) occur.
A simple example of this would be the moment a booking is created. Through webhooks, third parties can subscribe to that webhook ('Booking.Create'), and every time a booking is created, they will receive an HTTPS call to a predefined url, with predefined headers and body contents.
Webhook is both the event and the actual callback (or set of callbacks). Webhooks have a name ('BookingUpdated' or 'BookingExpired') and a payload, which is the contextual data for that event (the booking data in the case of a Booking.Updated webhook, the customer data in case of the 'CustomerUpdated' webhook). Every time the event occurs, the webhook is triggered, meaning that the webhook framework starts processing the event and the corresponding 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. |
The first webhook notification is sent immediately after the event is triggered. We have a retry mechanism in place, and in case status 200 OK is not returned in the first try we will send the notification again later.
According to our retry policy we will try to send the webhook 4 more times with an increasing interval. If after the 5th call we still do not get a 200 OK response (which is after 60 minutes), we will stop trying and the webhook will be marked as Failed.
| Attempt | Interval |
|---|---|
| 1st | Immediately after event is triggered. |
| 2nd | 1 minute |
| 3rd | 5 minutes |
| 4th | 15 minutes |
| 5th | 60 minutes |
The configuration for the webhooks is done in briq.app. You will need to set a valid URL for each of the events you would like to receive notifications for. Please contact our team to help you out with configuring the webhooks.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article