Webhooks Overview

What are Webhooks?

Webhooks allow external applications to receive notifications about events happening in BRM. When a specific event occurs in BRM, a webhook sends relevant data to a designated endpoint.

What Data Can BRM Send via Webhook? 

Currently, BRM can send reservation data and customer data to an endpoint in JSON format. 

Examples of data sent by BRM include customer data and reservation data in response to specific webhook triggers. 

Webhook Trigger Events

Webhooks can be triggered by actions related to customer records or reservations. Below are the events that can trigger each type of webhook: 

Customer Record:
The following actions can trigger the customer webhook:

• Creating a new customer
• Updating an existing customer record

If selected, these actions will result in a copy of the customer record being sent to the endpoint in JSON format, see this example. 

Reservation:
The following actions can trigger the reservation webhook:

• Creating a reservation
• Updating a reservation (e.g., change reservation stage, update dates and times, update delivery information)
• Creating, updating, or deleting reservation notes
• Adding, updating, or removing items from a reservation
  
  

If selected, these actions will result in a copy of the reservation being sent to the endpoint in JSON format, see this example.

See also

Setting up webhooks

Example of customer JSON data sent by webhook

Example of reservation JSON data sent by webhook