Get sample webhook data | Calendly | Developer Documentation

Test your webhook subscription

webhooks:read

Test your webhook subscription <Info title="Required scopes"> > `webhooks:read` </Info>

AuthorizationBearer

OAuth 2.0

AuthorizationBearer

Personal Access Token

eventenumRequired

organizationstringRequiredformat: "uri"

userstringOptionalformat: "uri"

scopeenumRequired

Allowed values:

groupstringOptionalformat: "uri"

eventenum

The event that caused the webhook to fire

created_atstringformat: "date-time"

The moment when the event was created (e.g. “2020-01-02T03:04:05.678123Z”)

created_bystringformat: "uri"

The user who created the webhook

payloadobject

The payload for the webhook event. The data in the payload depends on the event.

For example, an invitee.* event produces an Invitee object in the payload.

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	import { CalendlyClient } from "calendly";
2
3	async function main() {
4	const client = new CalendlyClient({
5	token: "YOUR_TOKEN_HERE",
6	});
7	await client.webhooks.getSampleWebhookData({
8	event: "invitee.created",
9	organization: "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
10	scope: "user",
11	});
12	}
13	main();

1	{
2	"event": "invitee.created",
3	"created_at": "2024-01-15T09:30:00Z",
4	"created_by": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
5	"payload": {
6	"contact": {
7	"deleted_at": "2026-05-06T13:35:50.580Z",
8	"uri": "https://api.calendly.com/contacts/CCCCCCCCCCCCCCCC"
9	},
10	"user_uuid": "b0af0294-9ec5-4eca-af5b-86d7d572955a"
11	}
12	}