Create Webhook Endpoint | Extend Documentation

from extend_ai import Extend, WebhookEndpointEventType
client = Extend(
    token="YOUR_TOKEN_HERE",
    extend_api_version="2026-02-09",
)
client.webhook_endpoints.create(
    url="https://example.com/webhooks",
    name="Production webhook",
    enabled_events=[
        WebhookEndpointEventType.EXTRACT_RUN_PROCESSED,
        WebhookEndpointEventType.WORKFLOW_CREATED
    ],
)

{
  "object": "webhook_endpoint",
  "id": "wh_Xj8mK2pL9nR4vT7qY5wZ",
  "url": "https://example.com/webhooks",
  "name": "Production webhook",
  "status": "enabled",
  "enabledEvents": [
    "extract_run.processed",
    "workflow.created"
  ],
  "apiVersion": {},
  "advancedOptions": {
    "headers": {},
    "payload": {
      "format": "json",
      "urlThresholdBytes": 1
    }
  },
  "signingSecret": "wss_Av9uCQNrCIEe0XpEpsQUVjEJYr4udK9N",
  "createdAt": "2024-01-15T09:30:00Z",
  "createdBy": {
    "type": "user",
    "email": "matt@extend.app"
  }
}

Create a new webhook endpoint. The response includes a signingSecret that is only returned once — store it securely for verifying webhook signatures.

The enabledEvents array specifies which global event types this endpoint should receive. Use the Webhook Events reference to see available event types.

To subscribe to events scoped to a specific resource (e.g., a single extractor or workflow), use Create Webhook Subscription after creating the endpoint.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

urlstringRequiredformat: "uri"

The URL that webhook events will be sent to.

namestringRequired>=1 character

A human-readable name for the webhook endpoint.

enabledEventslist of enumsRequired

The list of global event types to subscribe to. Pass an empty array to create an endpoint with no global events (useful if you only plan to use resource-scoped subscriptions).

apiVersionstringRequired

statusenumOptional

The status of the webhook endpoint.

Allowed values:

advancedOptionsobjectOptional

Advanced configuration options for the webhook endpoint, including custom headers and payload delivery settings.

Response

Successfully created webhook endpoint

objectenum

Allowed values:

idstring

Unique identifier for the webhook endpoint.

urlstringformat: "uri"

The URL that webhook events are sent to.

namestring

A human-readable name for the webhook endpoint.

statusenum

The status of the webhook endpoint.

Allowed values:

enabledEventslist of enums

The list of event types this endpoint is subscribed to at the global level. These are events that are not scoped to a specific resource.

apiVersionstring

advancedOptionsobject or null

Advanced configuration options for the webhook endpoint, including custom headers and payload delivery settings.

signingSecretstring

The signing secret used to verify webhook payloads. This is only returned when creating the endpoint and cannot be retrieved again.

Store it securely — you will need it to verify webhook signatures.

createdAtstringformat: "date-time"

The date and time the webhook endpoint was created.

createdByobject

The actor that created this resource.

user — the resource was created via the studio by a logged-in user. The user’s email is exposed.
api_key — the resource was created via the API using an API key. The key’s name is exposed.

May be null for resources created before attribution.

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

Authentication

Headers

Request

Response

Errors