Update webhook endpoint
Partial update; omitted fields are left unchanged. Set disabled to pause delivery without deleting the endpoint.
Authentication
Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.
Path parameters
Webhook endpoint id (prefixed whe_…).
Headers
Request
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.
Re-scope the endpoint: a proj_... id narrows it to that
project’s events, an explicit null makes it workspace-wide
(every project’s events), omitted leaves it unchanged. The
signing secret and delivery history are untouched, so
re-scoping never requires redeploying your receiver. An
unknown id returns 404 project_not_found. A project-pinned API
key may only scope an endpoint to its own project.
Payload-shaping keys (see WebhookEndpoint.include). Send [] to
clear back to the lean default.
Opt the endpoint into a different (typically newer) payload shape
(YYYY-MM-DD, see WebhookEndpoint.api_version). Omit to leave it
unchanged. An unknown version is rejected.
Response headers
Unique identifier for this request, present on every response (2xx and
non-2xx alike). If the caller sends a Speechify-Request-Id request
header the server echoes it back (sanitized and length-capped) so one
logical request can be traced end-to-end; otherwise the server generates
a fresh value. Log it on every response and quote it in support requests
- it is the stable handle that ties your observation to Speechify’s
server-side logs, and it matches the
request_idfield in the error envelope.
The legacy alias X-Request-ID carries the same value and is still
accepted on requests, until 2027-07-24. Prefer the un-prefixed name
(RFC 6648).
Response
The updated endpoint (without the signing secret).
Prefixed wire id (whe_<26 char Crockford base32>).
The events this endpoint receives: a list of catalog event names
(for example workspace.spend_budget.warning) or ["*"] for
every event, current and future.
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.
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.
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.
Optional human-readable label for the endpoint.
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.