Catalog
The AnyRoad catalog includes the following webhooks.
booking.confirmed
Triggered when a booking or registration is confirmed. Includes booking-level information and guest information about the booking guest.
booking.updated
Triggered when a booking or registration is updated (but not canceled). Includes booking-level information and guest information about the booking guest. Updates that trigger this webhook include:
rescheduling to another date or time
changing the number of tickets or add-ons
payment status changes from from "unpaid" to "paid-in-full"
booking.canceled
Triggered when a booking is canceled. Includes booking-level information and guest information about the booking guest.
guest.additional.updated
Triggered when an email address is added to an additional guest on a booking - either by staff or by the additional guest themselves (via FullView). Includes booking-level information and guest information about the additional guest. The "guest" grouping, "marketing_optins" grouping, and the ticket.qr_code apply to the additional guest specifically.
guest.answers
Triggered when a guest (booking or additional) answers a checkout or feedback question. Includes all questions and associated answers. All answers except written text display in english in order to standardize data, even if the guest answered in another language.
guest.checked-in
Triggered when a booking or additional guest is checked-in via AnyRoad. Includes booking and guest information about the guest checking in.
Schema
All webhooks share the same attributes and structure. A few attributes only appear in certain webhooks, as outlined below.
The marketing_optins grouping and attributes are being deprecated. Use the optins grouping and attributes instead.
Attribute | Description | Example |
account |
|
|
id | The AnyRoad user ID for an account. | 123456 |
booking |
|
|
booking_date | The date and time a booking was made, in RFC 3339 format. | 2002-07-22T18:25:57+00:00 |
id | The AnyRoad booking ID. | 456789 |
status | The status of a booking. Options include:
| confirmed |
modify_booking_ link | The link to the Guest Modify Booking page on AnyRoad that allows guests to reschedule or cancel a booking themselves.
This attribute will not appear in the webhook if this feature is not enabled on the booking. | |
experience_link | An external website link configured on an experience to which guests are directed during checkout and in booking emails.
This attribute will not appear in the webhook if this feature is not enabled on the booking. | |
fullview_link | The link to the FullView Guest Information page on AnyRoad where additional guests on a booking can add their contact information.
This attribute appears on a booking if FullView is enabled on the booking and if the number of guests on the booking is greater than one. The attribute will not appear if disabled. | |
experience |
|
|
id | The AnyRoad experience ID. | 678956 |
name | The public experience name. | Distillery Tour |
name_localized | The public experience name in the language of the booking, as defined in the booking.language attribute.
If you are using this data to send emails, always use this attribute instead of experience.name. If you are importing this data into a CRM or analytics warehouse, use experience.name to normalize the data. | Distillery Tour |
cancellation_policy | The cancellation policy for a booking. | This booking is non-refundable |
cancellation_policy_localized | The cancellation policy in the language of the booking, as defined in the booking.language attribute.
If you are using this data to send emails, always use this attribute instead of experience.cancellation_policy. If you are importing this data into a CRM or analytics warehouse, use experience.cancellation_policy to normalize the data. | This booking is non-refundable |
online_link | The link to the Online Experience page on AnyRoad for virtual experiences. Guests visit this page to start their virtual experience.
This attribute appears in the webhook on virtual experiences only. | |
guest |
|
|
Address | A group of guest address attributes, captured either via direct entry by guests when paying via credit card or IP address when no payment is associated with the booking or registration. On internal bookings or when the IP address cannot be captured this data may not be available. | - |
street_address_1 | The first line of the guest street address. | 123 Main St. |
street_address_2 | The second line of the guest street address. | Apt. 55 |
city | The guest city. | San Francisco |
state_region | The guest state or region. This attribute is standardized to the 2-digit code for US states. However, in certain cases this is a text entry field for guests - if they spell their state wrong the full text of their entry will appear in this field. | CA |
postal_code | The guest postal code. | 94115 |
country | The 2-digit ISO code of the country where the guest is located, if captured. | US |
time_zone | The time zone associated with the guest in the IANA Time Zone Database standard, displaying Continent/Region. If no address data is associated with the guest, this defaults to the time zone of your account. | America/Chicago |
id | The AnyRoad guest ID for the guest. | 56783 |
language | The language associated with the booking (based on the language chosen by the guest on checkout) in ISO 639-1 format, e.g. en-us represents American English. | en-us |
type | Whether guest information relates to the booking guest or an additional guest. Options include:
The guest.additional.updated webhook contains additional guest information. Other webhooks contain booker information. | booker |
first_name | The first name of the guest. | Jane |
last_name | The last name of the guest. | Doe |
name | The full first and last name of the guest. | Jane Doe |
The guest email address.
Email is an optional field in certain cases (e.g. Front Desk bookings), and bookings can be created by staff without an email address. In this case, webhooks will trigger but guest.email will not appear as an attribute in the webhook. | ||
phone | The phone number of the guest in E.164 format, preceded by a “+” and country code. | +1 (555) 555-5555 |
birthdate | The birthdate of the guest | 1990-01-17 |
gender | The gender of the guest. Options include:
Gender is derived from guest first name and location through AnyRoad algorithms, and attributed to a guest if the confidence level is greater than 90%. We do not ask guests to provide their gender. | female |
created | The date and time the guest record was created in AnyRoad, in RFC 3339 format. | 2002-07-22T18:25:57+00:00 |
updated | The date and time the guest record was last updated in AnyRoad, in RFC 3339 format. | 2002-07-22T18:25:57+00:00 |
optins |
|
|
general | The guest answer to a general marketing opt-in question presented to them. Options include:
If this attribute does not appear in the webhook, it means the guest was not presented a marketing opt-in question to answer. | yes |
The guest answer to an email-specific marketing opt-in question presented to them. Options include:
If this attribute does not appear in the webhook, it means the guest was not presented a marketing opt-in question to answer. | no | |
phone | The guest answer to a phone-specific marketing opt-in question presented to them. Options include:
If this attribute does not appear in the webhook, it means the guest was not presented a marketing opt-in question to answer. | partial |
ticket |
|
|
qr_code | The entire, unencoded string embedded in the QR code of the AnyRoad ticket associated with the guest.
This field is useful to pass to systems that want to search a guest record based on scanning and reading the QR code string in the AnyRoad ticket.
If FullView is enabled on a booking, ticket.qr_code displays a unique code for each guest on a booking. If FullView is not enabled, the QR code is associated with the first ticket on the booking.
This attribute will not appear in the webhook if tickets are not enabled on the booking. | data:application/json;base64,eyJiIjoiMTIzNDU2IiwidCI6IjEyMzQ1NiJ9 |
e_ticket_ link | The link to the e-tickets page on AnyRoad where guests can see, download, and print all tickets for a booking.
This attribute will not appear in the webhook if tickets are not enabled on the booking. | |
time_slot |
|
|
local_datetime_start | The date and time the booked experience starts, in the local time of the experience, in RFC 3339 format. | 2002-07-22T18:25:57+00:00 |
local_datetime_end | The date and time the booked experience ends, in the local time of the experience, in RFC 3339 format. | 2002-07-22T18:25:57+00:00. |
emails |
|
|
reply_to | If you want guest email replies to appear in the AnyRoad dashboard, set the reply-to email address in your outgoing emails to this address. This address is unique to each booking.
This attribute is only available for booker guests since AnyRoad does not support additional guests replying to emails. It will not appear in the guest.additional.updated webhook. | |
cancellation_note | This attribute only applies to and will appear in the booking.canceled webhook.
When staff cancels a booking in the AnyRoad dashboard, they have the option to include a custom note to the guest. This note is optional when canceling a booking. | We’re sorry you canceled and hope to see you again soon. |
payment |
|
|
status | The current payment status of a booking. Options include:
| paid-in-full |
currency | The ISO 4217 currency code associated with booking charges and payments. Currency is based on the currency set on the experience. | usd |
discount | The discount amount applied to the booking, if a discount code was used.
Amounts are represented in cents e.g. $20 is represented as 2000.
Set to 0 if there is no applicable discount. | 2000 |
tax | The tax amount paid by the guest on the booking as an additional item, if configured on your AnyRoad account. This is not VAT, which is a separate configuration and amount.
Amounts are represented in cents e.g. $0.75 is represented as 75.
Set to 0 if there is no applicable tax. | 75 |
guest_service_fee | The AnyRoad service fee amount paid or due by the guest on a booking. This includes all service fees passed to a guest and excludes any service fee absorbed by you.
Amounts are represented in cents e.g. $5 is represented as 500.
Set to 0 if there is no applicable guest service fee. | 500 |
total | The total booking amount paid or due by the guest on a booking, including all discounts, taxes, and service fees.
Amounts are represented in cents e.g. $30 is represented as 3000.
Set to 0 if there is no charge associated with a booking e.g. a free booking. | 3000 |
deposit | The deposit paid on a booking, if a deposit is collected and a remaining balance is due. Once the remaining balance on a booking is paid, payment.status changes to paid-in-full and this attribute is set to 0.
Amounts are represented in cents e.g. $10 is represented as 1000.
Set to 0 if there is no applicable deposit. | 1000 |
additional_charge | The additional amount charged on a booking when it is updated. This attribute only shows an amount, if applicable, on the booking.updated webhook.
Amounts are represented in cents e.g. $10 is represented as 1000.
Set to 0 if there is no additional charge. | 1000 |
refund | The refund applied to a booking when it is updated or canceled. This attribute only shows an amount, if applicable, on the booking.updated or the booking.canceled webhooks.
Amounts are represented in cents e.g. $5.35 is represented as 535.
Set to 0 if there is no applicable refund. | 535 |
payment_method | The payment method used on a booking, if applicable. Options include:
On paid bookings, where payment.status equals deposit-paid or paid-in-full, this attribute will show credit_card or cash.
If the guest applied a 100% discount on a paid booking, payment.status equals paid-in-full, and this attribute will show none.
On free or unpaid bookings, this attribute will always show none. | credit-card |
units | A grouping that includes each ticket and add-on on a booking. Each line item represents a unique combination of a particular unit and price. | - |
type | Whether the unit is a ticket or an addon. Options include:
| ticket |
name | The singular name of the ticket or add-on | Adult |
name_localized | The singular name of the ticket or add-on in the language of the booking, as defined in the booking.language attribute.
If you are using this data to send emails, always use this attribute instead of payment.units.name. If you are importing this data into a CRM or analytics warehouse, use payment.units.name to normalize the data. | Adult |
name_plural | The plural name of the ticket or add-on | Adults |
name_plural_localized | The plural name of the ticket or add-on in the language of the booking, as defined in the booking.language attribute.
If you are using this data to send emails, always use this attribute instead of payment.units.name_plural. If you are importing this data into a CRM or analytics warehouse, use payment.units.name_plural to normalize the data. | Adults |
price | The price per unit of the item, before discount, tax, or service fee.
Amounts are represented in cents e.g. $10 is represented as 1000.
Set to 0 for free items with no associated charge. | 1000 |
quantity | The number of associated units on the booking | 2 |
question_answers |
|
|
answer | The guest answer to a question presented to them on checkout or feedback. Answers can appear as:
All answers except written text responses display in english in order to standardize data, even if the guest answered in another language. This attribute only applies to and will appear in the guest.answers webhook.
These attributes will only appear in the guest.answers webhook. | 7 |
answer_date | The date and time the guest answer was submitted.
These attributes will only appear in the guest.answers webhook. | 2002-07-22T18:25:57+00:00 |
presentment_location | Where in the booking journey the question was presented and answered by the guest. Options include:
These attributes will only appear in the guest.answers webhook. | registration |
question | The full text of the question presented to the guest. All questions appear in english in order to standardize data, even if the guest was presented the question in another language.
These attributes will only appear in the guest.answers webhook. | How likely, on a scale of 0 to 10, are you to recommend our Brand to a friend? |
question_type | The type of question asked. Options include:
These attributes will only appear in the guest.answers webhook. | nps |