For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Book a demoLog in
DocumentationAPI ReferenceModel VersioningChangelog
DocumentationAPI ReferenceModel VersioningChangelog
    • Authentication
    • API Versioning
    • Deployments
    • Error Handling
  • Endpoints
      • POSTCreate Webhook Endpoint
      • GETList Webhook Endpoints
      • GETGet Webhook Endpoint
      • POSTUpdate Webhook Endpoint
      • DELDelete Webhook Endpoint
      • POSTCreate Webhook Subscription
      • GETList Webhook Subscriptions
      • GETGet Webhook Subscription
      • POSTUpdate Webhook Subscription
      • DELDelete Webhook Subscription
  • Webhook Events
LogoLogo
Book a demoLog in
EndpointsWebhooks

Create Webhook Subscription

POST
/webhook_subscriptions
POST
/webhook_subscriptions
1from extend_ai import Extend, WebhookSubscriptionResourceType, WebhookSubscriptionEventType
2
3client = Extend(
4    token="YOUR_TOKEN_HERE",
5    extend_api_version="2026-02-09",
6)
7
8client.webhook_subscriptions.create(
9    webhook_endpoint_id="wh_Xj8mK2pL9nR4vT7qY5wZ",
10    resource_type=WebhookSubscriptionResourceType.EXTRACTOR,
11    resource_id="ex_Xj8mK2pL9nR4vT7qY5wZ",
12    enabled_events=[
13        WebhookSubscriptionEventType.EXTRACT_RUN_PROCESSED,
14        WebhookSubscriptionEventType.EXTRACT_RUN_FAILED
15    ],
16)
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 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.
Was this page helpful?
Previous

List Webhook Subscriptions

Next
Built with

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.

Headers

x-extend-api-version"2026-02-09"OptionalDefaults to 2026-02-09
API version to use for the request. If you're using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a `400 Bad Request` or be set to a previous legacy version. See [API Versioning](https://docs.extend.ai/2026-02-09/api-reference/api-versioning) for more details.

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.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error

API version to use for the request. If you’re using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a 400 Bad Request or be set to a previous legacy version. See API Versioning for more details.