Rotate signing secret
Issues a new signing secret for an endpoint and returns the endpoint with the new secret, whsec_ plus 43 characters. The secret is in this response ONLY. For overlap_hours (from 0 to 72, default 24) every delivery carries two v1 signatures, the new secret first and then the previous one, so you can switch your verifier without losing events; with 0 the old secret stops at once. While the overlap lasts secret_rotation.previous_expires_at tells when the old secret stops. Your key needs the read scope of every event family the endpoint receives. With a test key no secret is issued and secret is null. Required scope: webhooks:manage. With a test key (vx_test_) it is simulated: nothing real happens and nothing is billed. Requires an Idempotency-Key header. NOT retriable: when the operation itself fails with a 429, a 5xx or a temporary 409, the outcome is uncertain and the key becomes “unknown” (the same key gives 409 idempotency_outcome_unknown); with no response at all, the same key returns the first outcome or that same 409. After idempotency_outcome_unknown, read the state of the resource and retry with a new key only if the operation did not happen. A 429 rate_limited from the request limit and 409 request_in_progress come before the operation and leave the key as it is: retry with the same key.
Authentication
Path parameters
Id of the webhook endpoint, as returned when it was created or by GET /webhook-endpoints.
Headers
API version for this request; defaults to the version the key is pinned to.
A unique value you generate for each new operation (16 to 64 letters, digits, hyphen or underscore; a UUID works). Repeating the same request with the same key within 24 hours returns the first response and does nothing again, when that response was a success or a 4xx error the same request would always get again (not 429, and not the temporary 409 codes request_in_progress, caller_has_active_call and caller_request_in_progress: for those, and for a 5xx, see the note on retrying in the operation); the same key with a different request is refused with idempotency_key_reused.
Request
For this many hours every delivery carries two signatures (the new secret first, then the previous one), so you can update your verifier without losing events. 0 = the old secret stops at once.
Response
Always webhook_endpoint.
Id of the endpoint: use it in GET /webhook-endpoints/{endpoint_id} and in the other endpoint operations.
The label you gave to the endpoint; null if it has none.
The event types the endpoint receives, by name (see GET /webhook-event-types).
true if call.ended and call.analyzed carry the transcript.
active: events are delivered. paused: you paused it, no events are queued. disabled: VoxAI stopped it, see disabled_reason; PATCH it with status: active to turn it on again, unless the reason is platform (403 webhook_endpoint_disabled_by_platform: contact support).
Why the endpoint is disabled; null otherwise. repeated_failures: VoxAI disabled it after at least 10 failed deliveries in a row and no success for 3 days. platform: disabled by VoxAI staff.
The version of the event envelope this endpoint receives (a date).
Set while the previous secret is still valid (every delivery carries two signatures).
When your server last answered a delivery with a 2xx status, ISO 8601 UTC; null if it never did.
Deliveries in a row that failed for good, after all their attempts. A success resets it to 0; a test or a resend never adds to it.
true with a test key: nothing was created and the id does not exist.
The NEW signing secret, whsec_ plus 43 characters, to use as the HMAC key as it is (the whole string, in UTF-8). Shown ONLY in this response. null with a test key.