> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.getvoxai.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.getvoxai.com/_mcp/server.

# Rotate signing secret

POST https://api.getvoxai.com/v1/webhook-endpoints/{endpoint_id}/rotate-secret
Content-Type: application/json

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.

Reference: https://docs.getvoxai.com/api-reference/webhooks/rotate-secret

## Authentication

- `Authorization` header (bearer token, required) — API key created by an Owner or Admin of the organization. Never in the query string.

## Request

### Path parameters

- `endpoint_id` (string, required) — Id of the webhook endpoint, as returned when it was created or by `GET /webhook-endpoints`.

### Headers

- `VoxAI-Version` (enum, optional) — API version for this request; defaults to the version the key is pinned to.
  - Allowed values: `2026-10-01`
- `Idempotency-Key` (string, required) — 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`.

### Body (application/json)

This endpoint expects an object.

- `overlap_hours` (integer, optional, default: 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

### 201

Created.

- `object` ("webhook_endpoint", required) — Always `webhook_endpoint`.
- `id` (string, required) — Id of the endpoint: use it in `GET /webhook-endpoints/{endpoint_id}` and in the other endpoint operations.
- `url` (string, required) — Where VoxAI sends the events.
- `description` (string, required, nullable) — The label you gave to the endpoint; `null` if it has none.
- `events` (list of string, required) — The event types the endpoint receives, by name (see `GET /webhook-event-types`).
- `include_transcript` (boolean, required) — `true` if `call.ended` and `call.analyzed` carry the transcript.
- `status` (enum, required) — `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: `active`, `paused`, `disabled`
- `disabled_reason` (enum, required) — 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: `repeated_failures`, `platform`
- `api_version` (string, required) — The version of the event envelope this endpoint receives (a date).
- `secret_rotation` (WebhookEndpointsEndpointIdRotateSecretPostResponsesContentApplicationJsonSchemaSecretRotation, required, nullable) — Set while the previous secret is still valid (every delivery carries two signatures).
- `last_success_at` (datetime, required, nullable) — When your server last answered a delivery with a 2xx status, ISO 8601 UTC; `null` if it never did.
- `consecutive_failures` (integer, required) — 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_at` (datetime, required) — When the endpoint was created, ISO 8601 UTC.
- `simulated` (boolean, required) — true with a test key: nothing was created and the id does not exist.
- `secret` (string, required, nullable) — 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

Possible errors: * `invalid_api_version`: The `VoxAI-Version` header names a version that does not exist. Use one of the versions listed in the `VoxAI-Version` parameter, or omit the header to use the version the key is pinned to. * `invalid_request`: The path, query or body does not match the schema of the operation: a missing or unknown field, a wrong type, a value out of range. Fix the request. `details` lists each problem as `{ location, path, message }`: `location` is `params`, `query` or `body` and `path` points to the field.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

### 401 Unauthorized Error

Possible errors: - `invalid_api_key`: The `Authorization` header is missing, malformed, or carries a key that does not exist, was revoked or has expired. Send `Authorization: Bearer vx_live_…` (or `vx_test_…`) with an active key. Create a new key in the app if this one expired.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

### 403 Forbidden Error

Possible errors: - `feature_not_available`: The plan of the organization does not include the API, or the feature this operation needs. Upgrade the plan in the app. Reads and deletions stay available after a downgrade. - `insufficient_scope`: The key does not have the scope this operation requires (written in the description of the operation). Create a key with the required scope (an Owner or Admin can do it in the app), or ask for the scope to be added. - `ip_not_allowed`: The key has an IP allow-list and the request comes from an address that is not on it. Call from an allowed address, or add this address to the key in the app. - `organization_suspended`: The organization that owns the key is suspended. Contact the organization Owner: nothing can be done through the API until the organization is active again.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

### 404 Not Found Error

Possible errors: - `not_found`: The resource does not exist, or it belongs to another organization: the two cases give the same answer on purpose. Check the id. Ids come from the list operations of the same organization.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

### 409 Conflict Error

Possible errors: * `idempotency_outcome_unknown`: A previous request with this `Idempotency-Key` failed with a `429`, a `5xx` or a temporary `409` inside a NOT retriable operation, or was interrupted with no response, so its outcome is not known and it is never run again with the same key. Read the state of the resource (for example `GET /outbound-calls/{outbound_call_id}` or the list) and retry with a NEW key only if the operation did not happen. * `license_not_active`: The organization has no active plan (for example it expired). Renew the plan in the app. * `request_in_progress`: A request with the same `Idempotency-Key` is still running. Wait a few seconds and retry with the same key: you will get the outcome of the first request.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

### 422 Unprocessable Entity Error

Possible errors: - `idempotency_key_reused`: The same `Idempotency-Key` was already used in the last 24 hours with a different request (other operation, path or body). Use a new key for a new request. Reuse a key only to repeat exactly the same request.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

### 429 Too Many Requests Error

Possible errors: - `rate_limited`: Too many requests: over the per-minute limit of this key or of the whole organization (see `rate_limits` in `GET /me`), or over a limit of the operation itself, such as the hourly limit on webhook tests and resends. Wait for the number of seconds in the `Retry-After` header, then retry. Spread requests over time.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

### 500 Internal Server Error

Possible errors: - `internal_error`: An unexpected error on our side. Retry once after a few seconds. For writes marked as retriable, retry with the same `Idempotency-Key`, so the operation is never done twice; for the other writes, first read the state of the resource, then retry with a NEW key only if the operation did not happen. If it persists, contact support with the `requestId`.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

### 503 Service Unavailable Error

Possible errors: - `api_not_configured`: The API is not enabled on this service. Contact support. - `webhooks_not_configured`: Webhooks are not enabled on this service. Contact support.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

## Types

### WebhookEndpointsEndpointIdRotateSecretPostResponsesContentApplicationJsonSchemaSecretRotation

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

- `previous_expires_at` (datetime, required) — ISO 8601, UTC.

## Examples

**Request**

```json
{
  "overlap_hours": 24
}
```

**Response**

```json
{
  "object": "webhook_endpoint",
  "id": "3b9e5a71-6c2d-4f48-b0a3-8d1e7c4f2a96",
  "url": "https://example.com/hooks/voxai",
  "description": "CRM sync",
  "events": [
    "call.ended",
    "call.analyzed"
  ],
  "include_transcript": false,
  "status": "active",
  "disabled_reason": null,
  "api_version": "2026-10-01",
  "secret_rotation": {
    "previous_expires_at": "2026-11-17T10:30:00Z"
  },
  "last_success_at": "2026-11-16T09:45:03Z",
  "consecutive_failures": 0,
  "created_at": "2026-11-02T14:20:41Z",
  "simulated": false,
  "secret": "whsec_EXAMPLE-ONLY-not-a-real-secret-000000000000"
}
```

**SDK Code**

```python
import requests

url = "https://api.getvoxai.com/v1/webhook-endpoints/3b9e5a71-6c2d-4f48-b0a3-8d1e7c4f2a96/rotate-secret"

payload = { "overlap_hours": 24 }
headers = {
    "Idempotency-Key": "3f1c9a72-5d4e-4b8a-9c6f-0e2d7a1b4c58",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.getvoxai.com/v1/webhook-endpoints/3b9e5a71-6c2d-4f48-b0a3-8d1e7c4f2a96/rotate-secret';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '3f1c9a72-5d4e-4b8a-9c6f-0e2d7a1b4c58',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"overlap_hours":24}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getvoxai.com/v1/webhook-endpoints/3b9e5a71-6c2d-4f48-b0a3-8d1e7c4f2a96/rotate-secret"

	payload := strings.NewReader("{\n  \"overlap_hours\": 24\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "3f1c9a72-5d4e-4b8a-9c6f-0e2d7a1b4c58")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.getvoxai.com/v1/webhook-endpoints/3b9e5a71-6c2d-4f48-b0a3-8d1e7c4f2a96/rotate-secret")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '3f1c9a72-5d4e-4b8a-9c6f-0e2d7a1b4c58'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"overlap_hours\": 24\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.getvoxai.com/v1/webhook-endpoints/3b9e5a71-6c2d-4f48-b0a3-8d1e7c4f2a96/rotate-secret")
  .header("Idempotency-Key", "3f1c9a72-5d4e-4b8a-9c6f-0e2d7a1b4c58")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"overlap_hours\": 24\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.getvoxai.com/v1/webhook-endpoints/3b9e5a71-6c2d-4f48-b0a3-8d1e7c4f2a96/rotate-secret', [
  'body' => '{
  "overlap_hours": 24
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
    'Idempotency-Key' => '3f1c9a72-5d4e-4b8a-9c6f-0e2d7a1b4c58',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.getvoxai.com/v1/webhook-endpoints/3b9e5a71-6c2d-4f48-b0a3-8d1e7c4f2a96/rotate-secret");
var request = new RestRequest(Method.POST);
request.AddHeader("Idempotency-Key", "3f1c9a72-5d4e-4b8a-9c6f-0e2d7a1b4c58");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"overlap_hours\": 24\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Idempotency-Key": "3f1c9a72-5d4e-4b8a-9c6f-0e2d7a1b4c58",
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["overlap_hours": 24] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.getvoxai.com/v1/webhook-endpoints/3b9e5a71-6c2d-4f48-b0a3-8d1e7c4f2a96/rotate-secret")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```