Create Webhook Subscription | Calendly | Developer Documentation

import { CalendlyClient } from "calendly";
async function main() {
    const client = new CalendlyClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.webhooks.createWebhookSubscription({
        url: "https://blah.foo/bar",
        events: [
            "invitee.created",
            "invitee.canceled",
            "invitee_no_show.created",
            "invitee_no_show.deleted",
        ],
        organization: "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
        user: "https://api.calendly.com/users/BBBBBBBBBBBBBBBB",
        scope: "user",
        signingKey: "5mEzn9C-I28UtwOjZJtFoob0sAAFZ95GbZkqj4y3i0I",
    });
}
main();

{
  "resource": {
    "uri": "https://api.calendly.com/webhook_subscriptions/AAAAAAAAAAAAAAAA",
    "callback_url": "https://blah.foo/bar",
    "created_at": "2019-08-24T14:15:22.123456Z",
    "updated_at": "2019-08-24T14:15:22.123456Z",
    "retry_started_at": "2019-08-24T14:15:22.123456Z",
    "state": "active",
    "events": [
      "invitee.created",
      "invitee.canceled",
      "invitee_no_show.created",
      "invitee_no_show.deleted",
      "meeting_recap.created",
      "meeting_recap.updated",
      "meeting_recap.deleted",
      "contact.created",
      "contact.updated",
      "contact.deleted"
    ],
    "scope": "user",
    "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
    "user": "https://api.calendly.com/users/BBBBBBBBBBBBBBBB",
    "group": null,
    "creator": "https://api.calendly.com/users/BBBBBBBBBBBBBBBB"
  }
}

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` Create separate Webhook Subscriptions for events with different subscription scopes.	`routing_forms:read`
contact.created	`organization` `user` `group`	`contacts:read`
contact.updated	`organization` `user` `group`	`contacts:read`
contact.deleted	`organization` `user` `group`	`contacts:read`

Required scopes

webhooks:write

Authentication

AuthorizationBearer

OAuth 2.0

AuthorizationBearer

Personal Access Token

Request

This endpoint expects an object.

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/overview/webhooks/webhook-signatures for additional information.

Response headers

LocationstringOptionalformat: "uri"

Response

Created

resourceobject

Webhook Subscription Object

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

503

Service Unavailable Error