API ReferenceWebhooks

Create Webhook Subscription

Create a Webhook Subscription for an Organization, User, or Group. * The `organization` subscription scope triggers the webhook for all subscribed events within the organization. * The `user` subscription scope only triggers the webhook for subscribed events that belong to the specific user. * The `group` subscription scope only triggers the webhook for subscribed events that belong to the specfic group. | Event | Allowed Subscription Scopes | Required Auth Scope | | ----- | ----- | ----- | | invitee.created | `organization` `user` `group` | `scheduled_events:read` | | invitee.canceled | `organization` `user` `group` | `scheduled_events:read` | | invitee_no_show.created | `organization` `user` `group` | `scheduled_events:read` | | invitee_no_show.deleted | `organization` `user` `group` | `scheduled_events:read` | | event_type.created | `organization` `user` `group` | `event_types:read` | | event_type.deleted | `organization` `user` `group` | `event_types:read` | | event_type.updated | `organization` `user` `group` | `event_types:read` | | meeting_recap.created | `user` | `meeting_recaps:read` | | meeting_recap.updated | `user` | `meeting_recaps:read` | | meeting_recap.deleted | `user` | `meeting_recaps:read` | | routing_form_submission.created | `organization` <br /> <small>Create separate Webhook Subscriptions for events with different subscription scopes.</small> | `routing_forms:read` | | contact.created | `organization` `user` `group` | `contacts:read` | | contact.updated | `organization` `user` `group` | `contacts:read` | | contact.deleted | `organization` `user` `group` | `contacts:read` | <Info title="Required scopes"> > `webhooks:write` </Info>

Authentication

AuthorizationBearer
OAuth 2.0
OR
AuthorizationBearer
Personal Access Token

Request

urlstringRequiredformat: "uri"
The URL where you want to receive POST requests for events you are subscribed to.
eventslist of enumsRequired
List of user events to subscribe to.
organizationstringRequiredformat: "uri"
The unique reference to the organization that the webhook will be tied to.
scopeenumRequired

Indicates whether the webhook subscription scope is organization, user, or group

Allowed values:
userstringOptionalformat: "uri"
The unique reference to the user that the webhook will be tied to.
groupstringOptionalformat: "uri"
The unique reference to the group that the webhook will be tied to.
signing_keystringOptional
Optional secret key shared between your application and Calendly. See https://developer.calendly.com/api-docs/ZG9jOjM2MzE2MDM4-webhook-signatures for additional information.

Response headers

LocationstringOptional

Response

Created
resourceobject
Webhook Subscription Object

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error