Webhooks are user-defined HTTP callbacks that are triggered by specific events in a software system. When an event occurs, the source site (AnyRoad.com) sends a message to the URL configured as the webhook in the destination system (Zapier, custom integration, etc.). Unlike typical API requests, which require you to repeatedly poll for data, webhooks provide real-time push-type data transfer (from AnyRoad to a destination system), making them efficient for event-driven data delivery.
Webhooks in Action
The practical use of webhooks can be seen in various scenarios such as notifications of new bookings that include guest information, experience data, and more. Whenever these events occur, the webhook sends this data immediately to specified endpoints, which can then take appropriate actions, such as updating databases, sending out communications, or triggering other processes.
Webhook support is available to all AnyRoad customers. We are initially rolling out webhooks on a request basis, so please reach out to your Customer Success Manager or to the Customer Support team to get webhook support turned on for your account.
The full AnyRoad webhook catalog and schema is here.
Webhook Settings
To navigate to the Webhooks Configuration Screen, click Settings from the AnyRoad Dashboard home screen.
Click Webhooks from the settings screen.
When you enter the webhooks section, this is what you see next.
Add Endpoint
In the Endpoint setup tab, you can define the settings of the destination to which AnyRoad events will be sent. To do so, click the +Add Endpoint button.
On the next page, you can see the following configuration options.
Endpoint URL - This is the URL where your desired event will be sent
Description - This description shows up in the AnyRoad webhook settings portal to help identify what the webhook was set up for
Event Filtering - This setting will let you select the events that you want AnyRoad to send to the endpoint you’re configuring
Rate Limits - This setting allows you to limit the volume of events we send to your callback endpoint
Custom Headers - You can have custom HTTP headers added to every webhook that AnyRoad sends to your endpoint
Event Catalog
This screen details all of the events that the AnyRoad platform can send to a webhook endpoint.
See the AnyRoad catalog and schema here.
Event Schema - An interactive schema explorer that corresponds to the webhook event payloads, their structure, and data types for each message sent
JSON Example - An example payload with sample data for each event in the catalog
Logs
The Logs tab has a table of all the messages sent from the AnyRoad platform with a detailed view to help with troubleshooting and message insights.
Message log list - A list of all the messages that have been sent from the AnyRoad platform.
Message log details - Click on an individual message event in the table and see details of each message to help with debugging and diagnostics.
Activity Charts
This page shows a line chart that summarizes the message volume as well as success and failure charts.
Test a new endpoint
Once you have an endpoint setup you can send test events from the AnyRoad platform to assist with configuring your data flows. Click on the Endpoints tab and then select an endpoint from the list.
Testing Tab
Select an event you want to test from the Send Event dropdown list. Once you have selected the event you want to test click the Send Example button. This will send a test event to your endpoint that you can use to debug and test how your endpoint receives an AnyRoad webhook.
If you have any additional questions, you can contact our Customer Experience team via chat or at [email protected].