Replace a webhook's signing secret
Replace a webhook's signing secret with a new one and return it once. The old secret stops working immediately, so the receiving system rejects deliveries until it is given the new secret: only do this when the user asks, for example after a leak. Deliveries are signed HMAC-SHA256 in X-VAI-Signature. Destructive, needs confirm: true. Requires workspace-admin.
Authorization
bearerAuth A personal access token from Settings > API tokens.
In: header
Path Parameters
Workspace slug (GET /me lists yours).
Header Parameters
A key you choose, such as a UUID, that makes this POST safe to retry. Within 24 hours the same key and request answers with the first successful answer and runs nothing, the same key with a different request answers 422 idempotency_key_reused, and a key whose request is still running answers 409 idempotency_key_in_use. A failed request keeps nothing, so the same key runs it again.
1 <= length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/workspaces/string/webhooks/string/rotate-secret" \ -H "Content-Type: application/json" \ -d '{}'{
"webhookId": "string",
"secret": "string",
"property1": null,
"property2": null
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}Send one event to the webhook again POST
Send one event to a webhook again, signed afresh, with the same body and X-VAI-Event-Id as the first time, so a receiver that de-duplicates on the id stays correct. Use it after fixing the receiving end. The eventId comes from list_webhook_deliveries. A body is kept for seven days (less when the workspace or agent keeps call data for less, and not at all in zero data retention); after that the event cannot be redelivered. The new attempt appears in list_webhook_deliveries with redelivery: true. Requires workspace-admin.
Update a webhook PATCH
Change an outbound webhook: which events it receives (events REPLACES the list, so read list_workspace_webhooks first and send the full set you want), pause or resume it (isActive), its https URL, or its label. Pass only what you want to change. Event keys: conversation.started, conversation.ended, call_log.completed, lead.received, lead.updated, campaign.launched, campaign.scheduled, campaign.paused, campaign.resumed, campaign.completed, campaign.cancelled, campaign.recipient.finished, alert.fired, metric.optimised. Changing the URL sends every future delivery, call details included, to the new address. Requires workspace-admin.