IMimprovado
Webhooks

Create a webhook endpoint

Register a new webhook endpoint and subscribe it to one or more event types. The endpoint is created in unverified status and a fresh secret is returned in the response. Use the verify action to activate the endpoint.

Important: event_types must contain identifiers returned by GET /api/v3/webhook_event_types/ (e.g. load_completed, transformation_completed). Unknown event names are accepted by the request but no deliveries will be sent for them — always source the names from the event types endpoint rather than hard-coding them.

post/api/v3/webhook_endpoints/

Request

Request body

urlstring uri required

HTTPS URL of the receiver that will accept event deliveries.

event_typesstring[]

Event types this endpoint will subscribe to. See GET /api/v3/webhook_event_types/ for the list of available event names. Duplicates are deduplicated server-side. May be empty.

Response

Webhook endpoint created

idinteger
urlstring uri
secretstring

64-character hex signing secret

status'unverified' | 'active'
consecutive_failuresinteger
created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.