List Webhook Subscriptions | Calendly | Developer Documentation

import { CalendlyClient } from "calendly";
async function main() {
    const client = new CalendlyClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.webhooks.listWebhookSubscriptions({
        organization: "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
        scope: "organization",
    });
}
main();

{
  "collection": [
    {
      "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"
      ],
      "scope": "user",
      "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
      "user": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
      "group": "https://api.calendly.com/groups/AAAAAAAAAAAAAAAA",
      "creator": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA"
    }
  ],
  "pagination": {
    "count": 20,
    "next_page": "https://api.calendly.com/webhook_subscriptions?count=1&page_token=sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi",
    "previous_page": "https://api.calendly.com/webhook_subscriptions?count=1&page_token=VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H",
    "next_page_token": "sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi",
    "previous_page_token": "VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H"
  }
}

Get a list of Webhook Subscriptions for a specified Organization, User, or Group.

Required scopes

webhooks:read

Get a list of Webhook Subscriptions for a specified Organization, User, or Group. <Info title="Required scopes"> > `webhooks:read` </Info>

Authentication

AuthorizationBearer

OAuth 2.0

AuthorizationBearer

Personal Access Token

Query parameters

organizationstringRequiredformat: "uri"

The given organization that owns the subscriptions being returned. This field is always required.

userstringOptionalformat: "uri"

Indicates if the results should be filtered by user. This parameter is only required if the scope parameter is set to user.

groupstringOptionalformat: "uri"

Indicates if the results should be filtered by group. This parameter is only required if the scope parameter is set to group.

page_tokenstringOptional

The token to pass to get the next or previous portion of the collection

countintegerOptional1-100Defaults to 20

The number of rows to return

sortstringOptional

Order results by the specified field and direction. Accepts comma-separated list of {field}:{direction} values. Supported fields are: created_at. Sort direction is specified as: asc, desc.

scopeenumRequired

Filter the list by organization, user, or group

Allowed values:

Response

collectionlist of objects

paginationobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error