Overview
AnyRoad has a full suite of REST APIs that provide you access to nearly every data element on the platform. If you use Zapier, and want to call AnyRoad APIs to augment any of your Zap workflows this article will show you how. In this example we'll use an AnyRoad webhook as the trigger (although, you can use any trigger and call AnyRoad APIs in any step of your workflows) and we'll subsequently make a call to the AnyRoad Guests API to retrieve the details of a guest.
This integration:
Allows you to leverage AnyRoad REST APIs in any of your Zap's
In order to use this integration you need:
An AnyRoad API Key (please reach out to your AnyRoad support staff to obtain a key)
A Zapier account with a Professional plan
Create a Zapier account
If you don't already have one, create a Zapier account with the Professional plan or higher in order to make API calls. Zapier charges based on the number of tasks per month, you can estimate the number of tasks you need by multiplying the average number of AnyRoad visitors per month by how many extra steps you add for calling AnyRoad APIs in your Zap workflow.
Configure the integration in Zapier
This integration requires that you have a trigger set up for your Zap. In this example we'll be setting up the trigger to be in incoming webhook from AnyRoad.
Step 1: Capture AnyRoad webhook
This step captures the webhook data from AnyRoad in Zapier. In order to complete this step, you’ll need to configure the webhook in the AnyRoad dashboard as well.
Create a new zap and choose Webhooks as the trigger and Catch Hook as the trigger event.
Click Continue twice (you can ignore “Pick off a child key”) to reach the Test tab.
At this point you’ll need to return to the AnyRoad Dashboard to configure your webhook (we'll be using a "booking confirmed" webhook in this example).
Step 2: Create a test booking in the AnyRoad platform
You will need to create a test booking to ensure that Zapier has access to real booking data to subsequently call APIs and test that your Zap workflow works correctly.
To create a test booking you can manually add a booking for an experience in AnyRoad
Once you’ve created a test booking in AnyRoad, click Test trigger in Zapier. You will see Request A, Requst B, etc. for any number of test bookings that you created in AnyRoad. Select a request and inspect the values in the request to make sure you're selecting the correct test booking. In this example we'll select the "Jane Doe" test record that we created in AnyRoad
Click Continue with selected record.
Step 3: Add a step to call AnyRoad API
In this step we'll configure Zapier to call the AnyRoad Guests API to pull additional information about the guest that created a booking.
Choose Webhooks for the next action.
For the Action event choose GET. Click Continue.
On the Configure tab, paste the AnyRoad API endpoint you want to call in the URL field.
When calling the Guest API we'll need to append the Guest Id to the end of the Guest API for each Zap run. To do this press the + icon in the URL field, and select the Guest Id field from the incoming webhook.
You should now see the Guest Id field appended to the end of the Guest API URL in the URL Field
Add your AnyRoad API key in the Headers section. You'll manually type X-API-KEY in all caps into the headers key field, and paste your AnyRoad API key into the headers value field, and click continue.
If your configuration was successful, you will see the details of the guest record for the guest id that was send via the webhook trigger.
