API ReferenceWebhooksEndpoints

Create webhook endpoint

Beta

Register a webhook endpoint. Speechify mints an HMAC signing secret and returns it in the response secret field — exactly once. Store it then; subsequent reads omit it (rotate it with the rotate-secret action if lost). Select events via enabled_events: a list of catalog event names or ["*"] for every event. Limited to 50 endpoints per workspace.

Authentication

AuthorizationBearer

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

Headers

Speechify-VersionstringOptional

Request

This endpoint expects an object.
urlstringRequiredformat: "uri"
HTTPS destination for event deliveries.
enabled_eventslist of stringsRequired

Catalog event names to subscribe to, or ["*"] for all events.

descriptionstring or nullOptional

Response

The created endpoint, including its one-time 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
422
Unprocessable Entity Error