When you create a webhook subscription, payloads will be sent in real time to your server endpoint when events are scheduled or canceled by invitees. When you create a webhook subscription, you can subscribe to either or both:
invitee.created
for only data about scheduled events by invitees
invitee.canceled
for only data about canceled events by invitees
Subscribing to both invitee.created
and invitee.canceled
events will return all scheduled and canceled events across all team members in your organization with a single subscription giving you full transparency into the success of meetings.
If you’re an owner or admin, the personal access token you generate will authenticate the POST request with:
the user
scope if you want to return a response payload for data about all scheduled events for yourself
the organization
scope if you want to return a response payload for data about all scheduled events for your organization
If you’re a team member and not an owner of admin of a Calendly organization, the personal access token you generate will only authenticate the POST request with the user
scope to return a response payload for data about your own scheduled events.
Before you create a webhook subscription, ensure that you have the organization
or the user
URI (see how to find the organization or user uri) depending on which events you want to scope for.
Make a POST request to the /webhook_subscriptions
endpoint.
Add your personal access token to authenticate the request.
Set your server endpoint in the url
value.
Set invitee.created
or invitee.canceled
(or both) for the events
value
Choose the user
or organization
value to isolate scheduled events to yourself or the organization.
Example request: curl --request POST --url https://api.calendly.com/webhook_subscriptions
--header 'Content-Type: application/json'
--header 'authorization: Bearer <your personal access token>'
--data '{
"url":"http://yourserverendpoint.com",
"events":["invitee.created",
"invitee.canceled"],
"organization":"https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
"scope":"organization"}'
(Optional) To find information about the Calendly member the event was scheduled with, make a GET request to the scheduled_events/{uuid}
endpoint. This URL can be found in the webhook payload in payload.event
.
Example request:curl --request GET \
The URI of the scheduled Calendly members can be found in
--url https://api.calendly.com/scheduled_events/CCCCCCCCCCCCCCCC \
--header 'authorization: Bearer <your personal access token>'event_memberships
. This endpoint will also allow you to find other event-specific information.
(Optional) To get data about an invitee such as name, email, and their answers to custom questions on an event booking page, use the URI property in the webhook payload to make a GET request to the /scheduled_events/{event_uuid}/invitees/{invitee_uuid}
endpoint.
When an invitee cancels an event, you can match them to an existing invitee in your system by comparing the URI. This will allow you to exclude the invitee or event from your data, or specifically track canceled or rescheduled events.
See how webhook payloads change when invitees reschedule events