endpoints

Create webhook endpoint

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. Optionally scope delivery to one project with project_id; omit it for a workspace-wide endpoint that receives every project's events. Limited to 50 endpoints per workspace.

post/v1/webhooks/endpoints

Request

  • Base URL: https://api.speechify.ai
  • URL: https://api.speechify.ai/v1/webhooks/endpoints
  • Auth: HTTP bearer

Headers

Speechify-Versionstring

Request body

urlstring uri required

HTTPS destination for event deliveries. Must be a publicly reachable host: loopback, private, link-local, and cloud-metadata addresses (and reserved hostnames like localhost) are rejected.

project_idstring nullable

Optionally scope the endpoint to one project (prefixed proj_... id): a scoped endpoint receives only that project's events. Omit (or null) for workspace-wide - it receives every project's events. An unknown id returns 404 project_not_found. A project-pinned API key creates into its own project and cannot name the workspace-wide tier.

enabled_eventsstring[] required

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

includestring[]

Optional payload-shaping keys (see WebhookEndpoint.include). Omit for the lean default.

api_versionstring date

Optionally pin the endpoint's payload shape to a dated version (YYYY-MM-DD, see WebhookEndpoint.api_version). Omit to use the workspace's current version. An unknown version is rejected.

descriptionstring nullable

Response

The created endpoint, including its one-time signing secret.

idstring required

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

urlstring uri required

HTTPS destination Speechify POSTs signed events to.

project_idstring nullable

The project whose events this endpoint receives (prefixed external id). Null means workspace-wide - it receives every project's events. Endpoints have no Default project.

An event is routed by the project frozen on the row that produced it (an API key's project, for example), and for a project.spend_budget.* event the project itself. Workspace-level events such as workspace.spend_budget.* belong to no project and reach workspace-wide endpoints only, so a scoped endpoint subscribed to those alone is refused with a 400 naming enabled_events rather than accepted and never delivered to. A scoped endpoint records no delivery for another project's events.

enabled_eventsstring[] required

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

includestring[] required

Per-event payload shaping. Deliveries are lean by default: data.object carries only the resource GET snapshot. List heavy collections here to have them appended under the event's data alongside object, so receivers behind hard request-size caps stay lean unless they opt in. An event's documentation names the keys it recognises. Empty = lean.

api_versionstring date required

The dated payload shape this endpoint receives (YYYY-MM-DD), the same versioning vocabulary the REST API uses. Every delivery is rendered back to this version and carries it in the Speechify-Version header and the payload's top-level version field. Defaults to your workspace's current version at creation; change it to opt into a newer shape.

descriptionstring nullable

Optional human-readable label for the endpoint.

disabledboolean required

When true, Speechify stops delivering to this 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.

created_atstring date-time required
updated_atstring date-time required

Changes

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