Create Webhook Subscription

Create a resource-scoped webhook subscription on an existing webhook endpoint.

Subscriptions let you receive events for a specific resource (e.g., a single extractor or workflow) rather than all resources of that type. The enabledEvents must be valid for the given resourceType and the endpoint’s apiVersion.

If a subscription already exists for the same endpoint and resource, it will be updated with the new enabledEvents instead of creating a duplicate.

Create a resource-scoped webhook subscription on an existing webhook endpoint. Subscriptions let you receive events for a specific resource (e.g., a single extractor or workflow) rather than all resources of that type. The `enabledEvents` must be valid for the given `resourceType` and the endpoint's `apiVersion`. If a subscription already exists for the same endpoint and resource, it will be updated with the new `enabledEvents` instead of creating a duplicate.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

webhookEndpointIdstringRequired

The ID of the webhook endpoint to attach this subscription to.

resourceTypeenumRequired

The type of resource the webhook subscription is for.

Allowed values:

resourceIdstringRequired

The ID of the resource to scope this subscription to.

enabledEventslist of enumsRequired

The event types to subscribe to. Must be valid for the given resourceType.

Response

Successfully created webhook subscription

objectenum

Allowed values:

idstring

Unique identifier for the webhook subscription.

webhookEndpointIdstring

The ID of the webhook endpoint this subscription belongs to.

resourceTypeenum

The type of resource the webhook subscription is for.

Allowed values:

resourceIdstring

The ID of the resource this subscription is scoped to (e.g., an extractor, classifier, splitter, or workflow).

enabledEventslist of enums

The list of event types this subscription is subscribed to. The valid event types depend on the resourceType.

createdAtstringformat: "date-time"

The date and time the webhook subscription was created.

1	import { ExtendClient } from "extend-ai";
2
3	async function main() {
4	const client = new ExtendClient({
5	token: "YOUR_TOKEN_HERE",
6	extendApiVersion: "2026-02-09",
7	});
8	await client.webhookSubscriptions.create({
9	webhookEndpointId: "wh_Xj8mK2pL9nR4vT7qY5wZ",
10	resourceType: "extractor",
11	resourceId: "ex_Xj8mK2pL9nR4vT7qY5wZ",
12	enabledEvents: [
13	"extract_run.processed",
14	"extract_run.failed",
15	],
16	});
17	}
18	main();

1	{
2	"object": "webhook_subscription",
3	"id": "whes_Xj8mK2pL9nR4vT7qY5wZ",
4	"webhookEndpointId": "wh_Xj8mK2pL9nR4vT7qY5wZ",
5	"resourceType": "extractor",
6	"resourceId": "ex_Xj8mK2pL9nR4vT7qY5wZ",
7	"enabledEvents": [
8	"extract_run.processed",
9	"extract_run.failed"
10	],
11	"createdAt": "2024-01-15T09:30:00Z"
12	}

Create Webhook Subscription

Authentication

Headers

Request

Response

Errors