API ReferenceWebhooksEndpoints

Update webhook endpoint

Beta

Partial update; omitted fields are left unchanged. Set disabled to pause delivery without deleting the endpoint.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Path parameters

webhook_endpoint_idstringRequired

Webhook endpoint id (prefixed whe_…).

Headers

Speechify-VersionstringOptional

Request

This endpoint expects an object.
urlstringOptionalformat: "uri"
enabled_eventslist of stringsOptional
descriptionstring or nullOptional
disabledbooleanOptional

Response

The updated endpoint (without the signing secret).

idstring

Prefixed wire id (whe_<26 char Crockford base32>).

urlstringformat: "uri"
HTTPS destination Speechify POSTs signed events to.
enabled_eventslist of strings

The events this endpoint receives: a list of catalog event names (see WebhookEventType) or ["*"] for every event, current and future.

disabledboolean
When true, Speechify stops delivering to this endpoint.
created_atdatetime
updated_atdatetime
descriptionstring or null

Optional human-readable label for the endpoint.

secretstring

The HMAC-SHA256 signing secret (whsec_…) used to verify the Speechify-Signature header. Returned ONLY when the endpoint is created or its secret is rotated — it is never shown again.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error