Skip to navigation

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

AuthorizationBearer
API key created by an Owner or Admin of the organization. Never in the query string.

Path parameters

endpoint_idstringRequiredformat: "uuid"

Id of the webhook endpoint, as returned when it was created or by GET /webhook-endpoints.

Headers

VoxAI-VersionenumOptional

API version for this request; defaults to the version the key is pinned to.

Allowed values:
Idempotency-KeystringRequiredformat: "^[A-Za-z0-9_-]{16,64}$"

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

This endpoint expects an object.
overlap_hoursintegerOptional0-72Defaults to 24

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

Created.
object"webhook_endpoint"

Always webhook_endpoint.

idstringformat: "uuid"

Id of the endpoint: use it in GET /webhook-endpoints/{endpoint_id} and in the other endpoint operations.

urlstring
Where VoxAI sends the events.
descriptionstring or null

The label you gave to the endpoint; null if it has none.

eventslist of strings

The event types the endpoint receives, by name (see GET /webhook-event-types).

include_transcriptboolean

true if call.ended and call.analyzed carry the transcript.

statusenum

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).

Allowed values:
disabled_reasonenum

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.

Allowed values:
api_versionstring

The version of the event envelope this endpoint receives (a date).

secret_rotationobject or null

Set while the previous secret is still valid (every delivery carries two signatures).

last_success_atdatetime or null

When your server last answered a delivery with a 2xx status, ISO 8601 UTC; null if it never did.

consecutive_failuresinteger>=0

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.

created_atdatetime
When the endpoint was created, ISO 8601 UTC.
simulatedboolean

true with a test key: nothing was created and the id does not exist.

secretstring or null

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.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error