Events
Availies sends 8 kinds of event to the webhook endpoints an account has set up. This page lists each one with the exact fields of its body, generated from the same description the product's own tests check every body against.
How an event travels, how it is signed and what happens when your endpoint fails is on the webhooks page.
-
booking.canceled -
booking.created -
booking.host_changed -
booking.outcome_set -
booking.rescheduled -
delivery.dead -
routing.submitted -
webhook.test
The envelope
-
Every body has
type,timestamp(ISO 8601, UTC),id(equal to thewebhook-idheader),account_idanddata. A booking event addsbooking_idandbooking_version. A routing event addsrouting_submission_id. -
Every booking event's
dataalso says who made the booking and where. Increated_by,typeisvisitor,member,api_keyorsystem, andassistant_grant_idis set when a member booked through an assistant.channelisbooking_page,embed,api,assistantorimport. These are set when the booking is made and never change. -
requested_byis the issuing system's claim about who asked for the link or the booking, with the member or key that made the claim. Trustrefonly when the issuer is a credential you know to be yours. - A reschedule is one event, not a cancel followed by a create. A receiver that needs the two steps can derive them. The reverse is not possible.
-
The fields under
data.reference(the event type's name, each host's name and email) are reference data as they were just before the event, not tied to the booking's version. Read the current value by id through the API. - Manage links are valid only for their version and until the later of 24 hours after the meeting starts and 10 minutes after the event, so a replay can carry expired links. A manage link is a secret the consumer must guard, because whoever holds it can move or cancel that booking until the link expires.
- The body is frozen when the event is written. A retry or a replay sends the same bytes. Bodies are never cut: the largest the field limits allow is about 300 KB, almost all of it the visitor's answers.
- A receiver ignores fields it does not know. New fields are added without a new version.
Names that are not sent
booking.completed is not sent, because nothing stores an elapsed state. Read the
booking's end or listen for booking.outcome_set.
booking.details_updated can be subscribed to but is never sent yet, because no
operation changes a booking's answers, guests or location outside a host change.
booking.canceled
The booking was canceled: who, why, and whether it is part of a reschedule.
| Field | Type | Always sent | Notes |
|---|---|---|---|
type
|
string | yes |
Values:
booking.canceled
.
|
timestamp
|
string | yes | When the change happened. Limits: format date-time. |
id
|
string | yes |
The event's id, equal to the webhook-id header.
Limits: at least 1 character.
|
account_id
|
string | yes | Limits: at least 1 character. |
booking_id
|
string | yes | Limits: at least 1 character. |
booking_version
|
integer | yes | Limits: at least 1. |
data
|
object | yes | |
data.status
|
string | yes |
Values:
pending
,
confirmed
,
canceled
,
expired
.
|
data.outcome
|
string or null | yes |
Values:
attended
,
no_show
.
|
data.event_type_id
|
string | yes | Limits: at least 1 character. |
data.start
|
string | yes | Limits: format date-time. |
data.end
|
string | yes | Limits: format date-time. |
data.organizer_host_id
|
string | yes | Limits: at least 1 character. |
data.hosts
|
array of object | yes | The hosts at this version, the organizer first. Limits: at least 1 item. |
data.hosts[]
|
object | yes | |
data.hosts[].host_id
|
string | yes | Limits: at least 1 character. |
data.hosts[].role
|
string | yes |
Values:
organizer
,
co_host
.
|
data.visitor
|
object | yes | |
data.visitor.name
|
string or null | yes | |
data.visitor.email
|
string or null | yes | |
data.visitor.phone
|
string or null | yes | |
data.visitor.time_zone
|
string or null | yes | |
data.visitor.language
|
string | yes | |
data.guests
|
array of object | yes | |
data.guests[]
|
object | yes | |
data.guests[].name
|
string or null | yes | |
data.guests[].email
|
string | yes | |
data.answers
|
array of object | yes | In the order they were asked. |
data.answers[]
|
object | yes | |
data.answers[].question_id
|
string | yes | Limits: at least 1 character. |
data.answers[].label
|
string | yes | The question as it was asked. |
data.answers[].kind
|
string | yes | The question's kind as it was asked. |
data.answers[].answer
|
any JSON value | yes | The answer as stored: text, the chosen options of a multiple choice, or null; any JSON value the booking stored. |
data.location
|
object | yes | |
data.location.kind
|
string | yes |
Values:
google_meet
,
microsoft_teams
,
phone
,
in_person
,
custom_text
.
|
data.location.value
|
string or null | yes | |
data.location.meeting_url
|
string or null | yes | |
data.attribution
|
map of text to string or null | yes | The attribution pairs the visitor arrived with, keys sorted, or null. |
data.external_ref
|
string or null | yes | |
data.created_by
|
object | yes | Who made the booking in the product: the visitor on a booking page, a member (directly or through an assistant), an API key, or the system. Set once when the booking is made; every event of the booking repeats it. |
data.created_by.type
|
string | yes |
Values:
visitor
,
member
,
api_key
,
system
.
|
data.created_by.id
|
string or null | yes | The member's or the key's id. Null for the visitor and for the system. Limits: at least 1 character. |
data.created_by.assistant_grant_id
|
string or null | yes |
The assistant grant the member acted through, or null. Set only when type is member.
Limits: at least 1 character.
|
data.requested_by
|
object or null | yes |
Who asked for the booking in the system that minted its prefilled link, as that system claims, and whose claim it is. It names who asked for the link, not who completed the booking: the person on the page may be someone else. Set once when the booking is made; every event of the booking repeats it. Null when none was given, and once the visitor's data is scrubbed. Never the actor: created_by says who acted in the product.
|
data.requested_by.ref
|
string | yes | The issuing system's own reference to the person who asked for the booking, exactly as it was given. Opaque to the product: a hint, never authority. Limits: at least 1 character. |
data.requested_by.issuer
|
object | yes |
The credential that minted the prefilled link, or made the booking through the API: a member or a key of this account, by id. Trust ref as one of your own users only when this is a credential you know to be yours.
|
data.requested_by.issuer.type
|
string | yes |
Values:
member
,
api_key
.
|
data.requested_by.issuer.id
|
string | yes | Limits: at least 1 character. |
data.channel
|
string | yes |
Where the booking was made: booking_page, embed (the booking page inside another site), api (a key, or a member in the app), assistant (a member's assistant), or import.
Values:
booking_page
,
embed
,
api
,
import
,
assistant
.
|
data.routing_submission_id
|
string or null | yes | The routing form submission that led to the booking, or null. Limits: at least 1 character. |
data.manage_links
|
object or null | yes |
Links to manage the booking at this version only, valid until expires_at (the later of 24 hours after the meeting starts and 10 minutes after the event). A replay can carry expired links. Null when the booking can no longer be managed. A manage link is a secret the consumer must guard.
|
data.manage_links.cancel_url
|
string | yes | |
data.manage_links.reschedule_url
|
string | yes | |
data.manage_links.expires_at
|
string | yes | Limits: format date-time. |
data.canceled_by
|
string | yes |
Values:
invitee
,
host
,
member
,
api_key
,
system
,
calendar
.
|
data.cancel_reason
|
string or null | yes | |
data.part_of_reschedule
|
boolean | yes | |
data.reference
|
object | yes | Reference data as it was just before the event, not tied to the booking's version: the event type's name and each named host's name, email and external ids. A change to any of them writes no booking version and sends no event. Read the current value by id through the API. |
data.reference.event_type
|
object | yes | |
data.reference.event_type.id
|
string | yes | Limits: at least 1 character. |
data.reference.event_type.name
|
string or null | yes | |
data.reference.hosts
|
array of object | yes | |
data.reference.hosts[]
|
object | yes | |
data.reference.hosts[].host_id
|
string | yes | Limits: at least 1 character. |
data.reference.hosts[].display_name
|
string | yes | |
data.reference.hosts[].email
|
string | yes | |
data.reference.hosts[].external_ids
|
map of text to string | yes |
The host's ids in other systems: an object from the system name the account chose to the id, names sorted; empty when there are none. A name the product writes itself begins with _. An id is given exactly as it was stored.
|
booking.created
A booking is confirmed.
| Field | Type | Always sent | Notes |
|---|---|---|---|
type
|
string | yes |
Values:
booking.created
.
|
timestamp
|
string | yes | When the change happened. Limits: format date-time. |
id
|
string | yes |
The event's id, equal to the webhook-id header.
Limits: at least 1 character.
|
account_id
|
string | yes | Limits: at least 1 character. |
booking_id
|
string | yes | Limits: at least 1 character. |
booking_version
|
integer | yes | Limits: at least 1. |
data
|
object | yes | |
data.status
|
string | yes |
Values:
pending
,
confirmed
,
canceled
,
expired
.
|
data.outcome
|
string or null | yes |
Values:
attended
,
no_show
.
|
data.event_type_id
|
string | yes | Limits: at least 1 character. |
data.start
|
string | yes | Limits: format date-time. |
data.end
|
string | yes | Limits: format date-time. |
data.organizer_host_id
|
string | yes | Limits: at least 1 character. |
data.hosts
|
array of object | yes | The hosts at this version, the organizer first. Limits: at least 1 item. |
data.hosts[]
|
object | yes | |
data.hosts[].host_id
|
string | yes | Limits: at least 1 character. |
data.hosts[].role
|
string | yes |
Values:
organizer
,
co_host
.
|
data.visitor
|
object | yes | |
data.visitor.name
|
string or null | yes | |
data.visitor.email
|
string or null | yes | |
data.visitor.phone
|
string or null | yes | |
data.visitor.time_zone
|
string or null | yes | |
data.visitor.language
|
string | yes | |
data.guests
|
array of object | yes | |
data.guests[]
|
object | yes | |
data.guests[].name
|
string or null | yes | |
data.guests[].email
|
string | yes | |
data.answers
|
array of object | yes | In the order they were asked. |
data.answers[]
|
object | yes | |
data.answers[].question_id
|
string | yes | Limits: at least 1 character. |
data.answers[].label
|
string | yes | The question as it was asked. |
data.answers[].kind
|
string | yes | The question's kind as it was asked. |
data.answers[].answer
|
any JSON value | yes | The answer as stored: text, the chosen options of a multiple choice, or null; any JSON value the booking stored. |
data.location
|
object | yes | |
data.location.kind
|
string | yes |
Values:
google_meet
,
microsoft_teams
,
phone
,
in_person
,
custom_text
.
|
data.location.value
|
string or null | yes | |
data.location.meeting_url
|
string or null | yes | |
data.attribution
|
map of text to string or null | yes | The attribution pairs the visitor arrived with, keys sorted, or null. |
data.external_ref
|
string or null | yes | |
data.created_by
|
object | yes | Who made the booking in the product: the visitor on a booking page, a member (directly or through an assistant), an API key, or the system. Set once when the booking is made; every event of the booking repeats it. |
data.created_by.type
|
string | yes |
Values:
visitor
,
member
,
api_key
,
system
.
|
data.created_by.id
|
string or null | yes | The member's or the key's id. Null for the visitor and for the system. Limits: at least 1 character. |
data.created_by.assistant_grant_id
|
string or null | yes |
The assistant grant the member acted through, or null. Set only when type is member.
Limits: at least 1 character.
|
data.requested_by
|
object or null | yes |
Who asked for the booking in the system that minted its prefilled link, as that system claims, and whose claim it is. It names who asked for the link, not who completed the booking: the person on the page may be someone else. Set once when the booking is made; every event of the booking repeats it. Null when none was given, and once the visitor's data is scrubbed. Never the actor: created_by says who acted in the product.
|
data.requested_by.ref
|
string | yes | The issuing system's own reference to the person who asked for the booking, exactly as it was given. Opaque to the product: a hint, never authority. Limits: at least 1 character. |
data.requested_by.issuer
|
object | yes |
The credential that minted the prefilled link, or made the booking through the API: a member or a key of this account, by id. Trust ref as one of your own users only when this is a credential you know to be yours.
|
data.requested_by.issuer.type
|
string | yes |
Values:
member
,
api_key
.
|
data.requested_by.issuer.id
|
string | yes | Limits: at least 1 character. |
data.channel
|
string | yes |
Where the booking was made: booking_page, embed (the booking page inside another site), api (a key, or a member in the app), assistant (a member's assistant), or import.
Values:
booking_page
,
embed
,
api
,
import
,
assistant
.
|
data.routing_submission_id
|
string or null | yes | The routing form submission that led to the booking, or null. Limits: at least 1 character. |
data.manage_links
|
object or null | yes |
Links to manage the booking at this version only, valid until expires_at (the later of 24 hours after the meeting starts and 10 minutes after the event). A replay can carry expired links. Null when the booking can no longer be managed. A manage link is a secret the consumer must guard.
|
data.manage_links.cancel_url
|
string | yes | |
data.manage_links.reschedule_url
|
string | yes | |
data.manage_links.expires_at
|
string | yes | Limits: format date-time. |
data.reference
|
object | yes | Reference data as it was just before the event, not tied to the booking's version: the event type's name and each named host's name, email and external ids. A change to any of them writes no booking version and sends no event. Read the current value by id through the API. |
data.reference.event_type
|
object | yes | |
data.reference.event_type.id
|
string | yes | Limits: at least 1 character. |
data.reference.event_type.name
|
string or null | yes | |
data.reference.hosts
|
array of object | yes | |
data.reference.hosts[]
|
object | yes | |
data.reference.hosts[].host_id
|
string | yes | Limits: at least 1 character. |
data.reference.hosts[].display_name
|
string | yes | |
data.reference.hosts[].email
|
string | yes | |
data.reference.hosts[].external_ids
|
map of text to string | yes |
The host's ids in other systems: an object from the system name the account chose to the id, names sorted; empty when there are none. A name the product writes itself begins with _. An id is given exactly as it was stored.
|
booking.host_changed
The booking moved to another host. hosts and organizer_host_id name the new host.
| Field | Type | Always sent | Notes |
|---|---|---|---|
type
|
string | yes |
Values:
booking.host_changed
.
|
timestamp
|
string | yes | When the change happened. Limits: format date-time. |
id
|
string | yes |
The event's id, equal to the webhook-id header.
Limits: at least 1 character.
|
account_id
|
string | yes | Limits: at least 1 character. |
booking_id
|
string | yes | Limits: at least 1 character. |
booking_version
|
integer | yes | Limits: at least 1. |
data
|
object | yes | |
data.status
|
string | yes |
Values:
pending
,
confirmed
,
canceled
,
expired
.
|
data.outcome
|
string or null | yes |
Values:
attended
,
no_show
.
|
data.event_type_id
|
string | yes | Limits: at least 1 character. |
data.start
|
string | yes | Limits: format date-time. |
data.end
|
string | yes | Limits: format date-time. |
data.organizer_host_id
|
string | yes | Limits: at least 1 character. |
data.hosts
|
array of object | yes | The hosts at this version, the organizer first. Limits: at least 1 item. |
data.hosts[]
|
object | yes | |
data.hosts[].host_id
|
string | yes | Limits: at least 1 character. |
data.hosts[].role
|
string | yes |
Values:
organizer
,
co_host
.
|
data.visitor
|
object | yes | |
data.visitor.name
|
string or null | yes | |
data.visitor.email
|
string or null | yes | |
data.visitor.phone
|
string or null | yes | |
data.visitor.time_zone
|
string or null | yes | |
data.visitor.language
|
string | yes | |
data.guests
|
array of object | yes | |
data.guests[]
|
object | yes | |
data.guests[].name
|
string or null | yes | |
data.guests[].email
|
string | yes | |
data.answers
|
array of object | yes | In the order they were asked. |
data.answers[]
|
object | yes | |
data.answers[].question_id
|
string | yes | Limits: at least 1 character. |
data.answers[].label
|
string | yes | The question as it was asked. |
data.answers[].kind
|
string | yes | The question's kind as it was asked. |
data.answers[].answer
|
any JSON value | yes | The answer as stored: text, the chosen options of a multiple choice, or null; any JSON value the booking stored. |
data.location
|
object | yes | |
data.location.kind
|
string | yes |
Values:
google_meet
,
microsoft_teams
,
phone
,
in_person
,
custom_text
.
|
data.location.value
|
string or null | yes | |
data.location.meeting_url
|
string or null | yes | |
data.attribution
|
map of text to string or null | yes | The attribution pairs the visitor arrived with, keys sorted, or null. |
data.external_ref
|
string or null | yes | |
data.created_by
|
object | yes | Who made the booking in the product: the visitor on a booking page, a member (directly or through an assistant), an API key, or the system. Set once when the booking is made; every event of the booking repeats it. |
data.created_by.type
|
string | yes |
Values:
visitor
,
member
,
api_key
,
system
.
|
data.created_by.id
|
string or null | yes | The member's or the key's id. Null for the visitor and for the system. Limits: at least 1 character. |
data.created_by.assistant_grant_id
|
string or null | yes |
The assistant grant the member acted through, or null. Set only when type is member.
Limits: at least 1 character.
|
data.requested_by
|
object or null | yes |
Who asked for the booking in the system that minted its prefilled link, as that system claims, and whose claim it is. It names who asked for the link, not who completed the booking: the person on the page may be someone else. Set once when the booking is made; every event of the booking repeats it. Null when none was given, and once the visitor's data is scrubbed. Never the actor: created_by says who acted in the product.
|
data.requested_by.ref
|
string | yes | The issuing system's own reference to the person who asked for the booking, exactly as it was given. Opaque to the product: a hint, never authority. Limits: at least 1 character. |
data.requested_by.issuer
|
object | yes |
The credential that minted the prefilled link, or made the booking through the API: a member or a key of this account, by id. Trust ref as one of your own users only when this is a credential you know to be yours.
|
data.requested_by.issuer.type
|
string | yes |
Values:
member
,
api_key
.
|
data.requested_by.issuer.id
|
string | yes | Limits: at least 1 character. |
data.channel
|
string | yes |
Where the booking was made: booking_page, embed (the booking page inside another site), api (a key, or a member in the app), assistant (a member's assistant), or import.
Values:
booking_page
,
embed
,
api
,
import
,
assistant
.
|
data.routing_submission_id
|
string or null | yes | The routing form submission that led to the booking, or null. Limits: at least 1 character. |
data.manage_links
|
object or null | yes |
Links to manage the booking at this version only, valid until expires_at (the later of 24 hours after the meeting starts and 10 minutes after the event). A replay can carry expired links. Null when the booking can no longer be managed. A manage link is a secret the consumer must guard.
|
data.manage_links.cancel_url
|
string | yes | |
data.manage_links.reschedule_url
|
string | yes | |
data.manage_links.expires_at
|
string | yes | Limits: format date-time. |
data.previous_host_id
|
string | yes | Limits: at least 1 character. |
data.reference
|
object | yes | Reference data as it was just before the event, not tied to the booking's version: the event type's name and each named host's name, email and external ids. A change to any of them writes no booking version and sends no event. Read the current value by id through the API. |
data.reference.event_type
|
object | yes | |
data.reference.event_type.id
|
string | yes | Limits: at least 1 character. |
data.reference.event_type.name
|
string or null | yes | |
data.reference.hosts
|
array of object | yes | |
data.reference.hosts[]
|
object | yes | |
data.reference.hosts[].host_id
|
string | yes | Limits: at least 1 character. |
data.reference.hosts[].display_name
|
string | yes | |
data.reference.hosts[].email
|
string | yes | |
data.reference.hosts[].external_ids
|
map of text to string | yes |
The host's ids in other systems: an object from the system name the account chose to the id, names sorted; empty when there are none. A name the product writes itself begins with _. An id is given exactly as it was stored.
|
booking.outcome_set
Staff recorded an outcome or a no-show, or cleared it (outcome is then null).
| Field | Type | Always sent | Notes |
|---|---|---|---|
type
|
string | yes |
Values:
booking.outcome_set
.
|
timestamp
|
string | yes | When the change happened. Limits: format date-time. |
id
|
string | yes |
The event's id, equal to the webhook-id header.
Limits: at least 1 character.
|
account_id
|
string | yes | Limits: at least 1 character. |
booking_id
|
string | yes | Limits: at least 1 character. |
booking_version
|
integer | yes | Limits: at least 1. |
data
|
object | yes | |
data.status
|
string | yes |
Values:
pending
,
confirmed
,
canceled
,
expired
.
|
data.outcome
|
string or null | yes |
Values:
attended
,
no_show
.
|
data.event_type_id
|
string | yes | Limits: at least 1 character. |
data.start
|
string | yes | Limits: format date-time. |
data.end
|
string | yes | Limits: format date-time. |
data.organizer_host_id
|
string | yes | Limits: at least 1 character. |
data.hosts
|
array of object | yes | The hosts at this version, the organizer first. Limits: at least 1 item. |
data.hosts[]
|
object | yes | |
data.hosts[].host_id
|
string | yes | Limits: at least 1 character. |
data.hosts[].role
|
string | yes |
Values:
organizer
,
co_host
.
|
data.visitor
|
object | yes | |
data.visitor.name
|
string or null | yes | |
data.visitor.email
|
string or null | yes | |
data.visitor.phone
|
string or null | yes | |
data.visitor.time_zone
|
string or null | yes | |
data.visitor.language
|
string | yes | |
data.guests
|
array of object | yes | |
data.guests[]
|
object | yes | |
data.guests[].name
|
string or null | yes | |
data.guests[].email
|
string | yes | |
data.answers
|
array of object | yes | In the order they were asked. |
data.answers[]
|
object | yes | |
data.answers[].question_id
|
string | yes | Limits: at least 1 character. |
data.answers[].label
|
string | yes | The question as it was asked. |
data.answers[].kind
|
string | yes | The question's kind as it was asked. |
data.answers[].answer
|
any JSON value | yes | The answer as stored: text, the chosen options of a multiple choice, or null; any JSON value the booking stored. |
data.location
|
object | yes | |
data.location.kind
|
string | yes |
Values:
google_meet
,
microsoft_teams
,
phone
,
in_person
,
custom_text
.
|
data.location.value
|
string or null | yes | |
data.location.meeting_url
|
string or null | yes | |
data.attribution
|
map of text to string or null | yes | The attribution pairs the visitor arrived with, keys sorted, or null. |
data.external_ref
|
string or null | yes | |
data.created_by
|
object | yes | Who made the booking in the product: the visitor on a booking page, a member (directly or through an assistant), an API key, or the system. Set once when the booking is made; every event of the booking repeats it. |
data.created_by.type
|
string | yes |
Values:
visitor
,
member
,
api_key
,
system
.
|
data.created_by.id
|
string or null | yes | The member's or the key's id. Null for the visitor and for the system. Limits: at least 1 character. |
data.created_by.assistant_grant_id
|
string or null | yes |
The assistant grant the member acted through, or null. Set only when type is member.
Limits: at least 1 character.
|
data.requested_by
|
object or null | yes |
Who asked for the booking in the system that minted its prefilled link, as that system claims, and whose claim it is. It names who asked for the link, not who completed the booking: the person on the page may be someone else. Set once when the booking is made; every event of the booking repeats it. Null when none was given, and once the visitor's data is scrubbed. Never the actor: created_by says who acted in the product.
|
data.requested_by.ref
|
string | yes | The issuing system's own reference to the person who asked for the booking, exactly as it was given. Opaque to the product: a hint, never authority. Limits: at least 1 character. |
data.requested_by.issuer
|
object | yes |
The credential that minted the prefilled link, or made the booking through the API: a member or a key of this account, by id. Trust ref as one of your own users only when this is a credential you know to be yours.
|
data.requested_by.issuer.type
|
string | yes |
Values:
member
,
api_key
.
|
data.requested_by.issuer.id
|
string | yes | Limits: at least 1 character. |
data.channel
|
string | yes |
Where the booking was made: booking_page, embed (the booking page inside another site), api (a key, or a member in the app), assistant (a member's assistant), or import.
Values:
booking_page
,
embed
,
api
,
import
,
assistant
.
|
data.routing_submission_id
|
string or null | yes | The routing form submission that led to the booking, or null. Limits: at least 1 character. |
data.manage_links
|
object or null | yes |
Links to manage the booking at this version only, valid until expires_at (the later of 24 hours after the meeting starts and 10 minutes after the event). A replay can carry expired links. Null when the booking can no longer be managed. A manage link is a secret the consumer must guard.
|
data.manage_links.cancel_url
|
string | yes | |
data.manage_links.reschedule_url
|
string | yes | |
data.manage_links.expires_at
|
string | yes | Limits: format date-time. |
data.reference
|
object | yes | Reference data as it was just before the event, not tied to the booking's version: the event type's name and each named host's name, email and external ids. A change to any of them writes no booking version and sends no event. Read the current value by id through the API. |
data.reference.event_type
|
object | yes | |
data.reference.event_type.id
|
string | yes | Limits: at least 1 character. |
data.reference.event_type.name
|
string or null | yes | |
data.reference.hosts
|
array of object | yes | |
data.reference.hosts[]
|
object | yes | |
data.reference.hosts[].host_id
|
string | yes | Limits: at least 1 character. |
data.reference.hosts[].display_name
|
string | yes | |
data.reference.hosts[].email
|
string | yes | |
data.reference.hosts[].external_ids
|
map of text to string | yes |
The host's ids in other systems: an object from the system name the account chose to the id, names sorted; empty when there are none. A name the product writes itself begins with _. An id is given exactly as it was stored.
|
booking.rescheduled
The booking's time changed. One event, not a cancel followed by a create.
| Field | Type | Always sent | Notes |
|---|---|---|---|
type
|
string | yes |
Values:
booking.rescheduled
.
|
timestamp
|
string | yes | When the change happened. Limits: format date-time. |
id
|
string | yes |
The event's id, equal to the webhook-id header.
Limits: at least 1 character.
|
account_id
|
string | yes | Limits: at least 1 character. |
booking_id
|
string | yes | Limits: at least 1 character. |
booking_version
|
integer | yes | Limits: at least 1. |
data
|
object | yes | |
data.status
|
string | yes |
Values:
pending
,
confirmed
,
canceled
,
expired
.
|
data.outcome
|
string or null | yes |
Values:
attended
,
no_show
.
|
data.event_type_id
|
string | yes | Limits: at least 1 character. |
data.start
|
string | yes | Limits: format date-time. |
data.end
|
string | yes | Limits: format date-time. |
data.organizer_host_id
|
string | yes | Limits: at least 1 character. |
data.hosts
|
array of object | yes | The hosts at this version, the organizer first. Limits: at least 1 item. |
data.hosts[]
|
object | yes | |
data.hosts[].host_id
|
string | yes | Limits: at least 1 character. |
data.hosts[].role
|
string | yes |
Values:
organizer
,
co_host
.
|
data.visitor
|
object | yes | |
data.visitor.name
|
string or null | yes | |
data.visitor.email
|
string or null | yes | |
data.visitor.phone
|
string or null | yes | |
data.visitor.time_zone
|
string or null | yes | |
data.visitor.language
|
string | yes | |
data.guests
|
array of object | yes | |
data.guests[]
|
object | yes | |
data.guests[].name
|
string or null | yes | |
data.guests[].email
|
string | yes | |
data.answers
|
array of object | yes | In the order they were asked. |
data.answers[]
|
object | yes | |
data.answers[].question_id
|
string | yes | Limits: at least 1 character. |
data.answers[].label
|
string | yes | The question as it was asked. |
data.answers[].kind
|
string | yes | The question's kind as it was asked. |
data.answers[].answer
|
any JSON value | yes | The answer as stored: text, the chosen options of a multiple choice, or null; any JSON value the booking stored. |
data.location
|
object | yes | |
data.location.kind
|
string | yes |
Values:
google_meet
,
microsoft_teams
,
phone
,
in_person
,
custom_text
.
|
data.location.value
|
string or null | yes | |
data.location.meeting_url
|
string or null | yes | |
data.attribution
|
map of text to string or null | yes | The attribution pairs the visitor arrived with, keys sorted, or null. |
data.external_ref
|
string or null | yes | |
data.created_by
|
object | yes | Who made the booking in the product: the visitor on a booking page, a member (directly or through an assistant), an API key, or the system. Set once when the booking is made; every event of the booking repeats it. |
data.created_by.type
|
string | yes |
Values:
visitor
,
member
,
api_key
,
system
.
|
data.created_by.id
|
string or null | yes | The member's or the key's id. Null for the visitor and for the system. Limits: at least 1 character. |
data.created_by.assistant_grant_id
|
string or null | yes |
The assistant grant the member acted through, or null. Set only when type is member.
Limits: at least 1 character.
|
data.requested_by
|
object or null | yes |
Who asked for the booking in the system that minted its prefilled link, as that system claims, and whose claim it is. It names who asked for the link, not who completed the booking: the person on the page may be someone else. Set once when the booking is made; every event of the booking repeats it. Null when none was given, and once the visitor's data is scrubbed. Never the actor: created_by says who acted in the product.
|
data.requested_by.ref
|
string | yes | The issuing system's own reference to the person who asked for the booking, exactly as it was given. Opaque to the product: a hint, never authority. Limits: at least 1 character. |
data.requested_by.issuer
|
object | yes |
The credential that minted the prefilled link, or made the booking through the API: a member or a key of this account, by id. Trust ref as one of your own users only when this is a credential you know to be yours.
|
data.requested_by.issuer.type
|
string | yes |
Values:
member
,
api_key
.
|
data.requested_by.issuer.id
|
string | yes | Limits: at least 1 character. |
data.channel
|
string | yes |
Where the booking was made: booking_page, embed (the booking page inside another site), api (a key, or a member in the app), assistant (a member's assistant), or import.
Values:
booking_page
,
embed
,
api
,
import
,
assistant
.
|
data.routing_submission_id
|
string or null | yes | The routing form submission that led to the booking, or null. Limits: at least 1 character. |
data.manage_links
|
object or null | yes |
Links to manage the booking at this version only, valid until expires_at (the later of 24 hours after the meeting starts and 10 minutes after the event). A replay can carry expired links. Null when the booking can no longer be managed. A manage link is a secret the consumer must guard.
|
data.manage_links.cancel_url
|
string | yes | |
data.manage_links.reschedule_url
|
string | yes | |
data.manage_links.expires_at
|
string | yes | Limits: format date-time. |
data.previous_start
|
string | yes | Limits: format date-time. |
data.previous_end
|
string | yes | Limits: format date-time. |
data.rescheduled_by
|
string | yes |
Values:
invitee
,
host
,
member
,
api_key
,
system
,
calendar
.
|
data.previous_host_id
|
string or null | yes |
The host the booking had before, when the reschedule also moved it to another host of a round-robin pool (an event type whose reschedule_host is any); hosts and organizer_host_id name the new host. Null when the host stayed.
Limits: at least 1 character.
|
data.reference
|
object | yes | Reference data as it was just before the event, not tied to the booking's version: the event type's name and each named host's name, email and external ids. A change to any of them writes no booking version and sends no event. Read the current value by id through the API. |
data.reference.event_type
|
object | yes | |
data.reference.event_type.id
|
string | yes | Limits: at least 1 character. |
data.reference.event_type.name
|
string or null | yes | |
data.reference.hosts
|
array of object | yes | |
data.reference.hosts[]
|
object | yes | |
data.reference.hosts[].host_id
|
string | yes | Limits: at least 1 character. |
data.reference.hosts[].display_name
|
string | yes | |
data.reference.hosts[].email
|
string | yes | |
data.reference.hosts[].external_ids
|
map of text to string | yes |
The host's ids in other systems: an object from the system name the account chose to the id, names sorted; empty when there are none. A name the product writes itself begins with _. An id is given exactly as it was stored.
|
delivery.dead
An earlier event could not be delivered to one endpoint after all retries. Sent to the account's other endpoints, never to the one that failed. Ids and codes only.
| Field | Type | Always sent | Notes |
|---|---|---|---|
type
|
string | yes |
Values:
delivery.dead
.
|
timestamp
|
string | yes | Limits: format date-time. |
id
|
string | yes | Limits: at least 1 character. |
account_id
|
string | yes | Limits: at least 1 character. |
data
|
object | yes | |
data.delivery_id
|
string | yes | Limits: at least 1 character. |
data.endpoint_id
|
string | yes | Limits: at least 1 character. |
data.event_id
|
string | yes | Limits: at least 1 character. |
data.event_type
|
string | yes | The type of the event that failed. |
data.subject_type
|
string | yes | |
data.subject_id
|
string | yes | Limits: at least 1 character. |
data.attempts
|
integer | yes | Limits: at least 0. |
data.last_http_status
|
integer or null | yes | |
data.last_error_code
|
string or null | yes |
routing.submitted
A routing form was submitted: the answers, the rule that matched, where the visitor was sent.
| Field | Type | Always sent | Notes |
|---|---|---|---|
type
|
string | yes |
Values:
routing.submitted
.
|
timestamp
|
string | yes | Limits: format date-time. |
id
|
string | yes | Limits: at least 1 character. |
account_id
|
string | yes | Limits: at least 1 character. |
routing_submission_id
|
string | yes | Limits: at least 1 character. |
data
|
object | yes | |
data.routing_form_id
|
string | yes | Limits: at least 1 character. |
data.form_version
|
integer | yes | Limits: at least 1. |
data.submitted_at
|
string | yes | Limits: format date-time. |
data.visitor_email
|
string or null | yes | |
data.answers
|
array of object | yes | |
data.answers[]
|
object | yes | |
data.answers[].question_id
|
string | yes | Limits: at least 1 character. |
data.answers[].label
|
string | yes | |
data.answers[].answer
|
string or array of string | yes | |
data.matched_rule_id
|
string or null | yes | Limits: at least 1 character. |
data.result
|
one of 3 shapes | yes | |
data.result{kind=event_type}
|
object | yes | Shape 1 of 3, where kind is event_type. |
data.result{kind=event_type}.kind
|
string | yes |
Values:
event_type
.
|
data.result{kind=event_type}.event_type_id
|
string | yes | Limits: at least 1 character. |
data.result{kind=url}
|
object | yes | Shape 2 of 3, where kind is url. |
data.result{kind=url}.kind
|
string | yes |
Values:
url
.
|
data.result{kind=url}.url
|
string | yes | |
data.result{kind=message}
|
object | yes | Shape 3 of 3, where kind is message. |
data.result{kind=message}.kind
|
string | yes |
Values:
message
.
|
data.result{kind=message}.message_text
|
string | yes | |
data.external_ref
|
string or null | yes | |
data.attribution
|
map of text to string or null | yes | The attribution pairs the visitor arrived with, keys sorted, or null. |
webhook.test
A test event a member sends to one endpoint. A fixed body naming no booking and no person; sent once, not stored, not retried.
| Field | Type | Always sent | Notes |
|---|---|---|---|
type
|
string | yes |
Values:
webhook.test
.
|
timestamp
|
string | yes | Limits: format date-time. |
id
|
string | yes | Limits: at least 1 character. |
account_id
|
string | yes | Limits: at least 1 character. |
data
|
object | yes | |
data.endpoint_id
|
string | yes | Limits: at least 1 character. |
data.message
|
string | yes |