Skip to navigation
API ReferenceWebhooks

Update a webhook endpoint

Authentication

X-API-KEYstring

PolyAI API key. Send it in the X-API-KEY header.

Path parameters

endpoint_idstringRequiredformat: "^whe_[A-Za-z0-9]+$"

The endpoint_id must be a prefixed ID (e.g. whe_9ZtRcXw3nByK5pVqMaEfJs).

Request

This endpoint expects any.

Response

Webhook endpoint updated successfully.
idstringformat: "^whe_[A-Za-z0-9]+$"
Unique webhook endpoint ID.
namestring1-255 characters

Human-readable name for the webhook endpoint.

urlstringformat: "uri"
HTTPS URL that receives webhook POST requests.
enabledbooleanDefaults to true
Whether the endpoint is active and receiving events.
event_typeslist of enums
Event types this endpoint is subscribed to.
Allowed values:
timeout_msinteger1000-30000Defaults to 5000

Request timeout in milliseconds (1000-30000).

created_atdatetime
Timestamp when the endpoint was created.
updated_atdatetime
Timestamp when the endpoint was last updated.
headersmap from strings to stringsOptionalDefaults to {}
Custom HTTP headers sent with each webhook request.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error