Webhooks

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.
EventAllowed Subscription ScopesRequired Auth Scope
invitee.createdorganization user groupscheduled_events:read
invitee.canceledorganization user groupscheduled_events:read
invitee_no_show.createdorganization user groupscheduled_events:read
invitee_no_show.deletedorganization user groupscheduled_events:read
event_type.createdorganization user groupevent_types:read
event_type.deletedorganization user groupevent_types:read
event_type.updatedorganization user groupevent_types:read
meeting_recap.createdusermeeting_recaps:read
meeting_recap.updatedusermeeting_recaps:read
meeting_recap.deletedusermeeting_recaps:read
routing_form_submission.createdorganization <br /> <small>Create separate Webhook Subscriptions for events with different subscription scopes.</small>routing_forms:read
contact.createdorganization user groupcontacts:read
contact.updatedorganization user groupcontacts:read
contact.deletedorganization user groupcontacts:read
<Info title="Required scopes"> > `webhooks:write` </Info>
post/webhook_subscriptions

Request

  • Base URL: https://api.calendly.com
  • URL: https://api.calendly.com/webhook_subscriptions
  • Auth: HTTP bearer

Request body

urlstring uri required

The URL where you want to receive POST requests for events you are subscribed to.

eventsWebhookSubscriptionsPostRequestBodyContentApplicationJsonSchemaEventsItems[] required

List of user events to subscribe to.

organizationstring uri required

The unique reference to the organization that the webhook will be tied to.

userstring uri

The unique reference to the user that the webhook will be tied to.

groupstring uri

The unique reference to the group that the webhook will be tied to.

scope'organization' | 'user' | 'group' required

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

signing_keystring

Optional secret key shared between your application and Calendly. See https://developer.calendly.com/api-docs/overview/webhooks/webhook-signatures for additional information.

Response

Created

Changes

No recorded changes to this operation across all 1 revision of this API.