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

# Test webhook endpoint

POST https://api.getvoxai.com/v1/webhook-endpoints/{endpoint_id}/test

Sends a signed `webhook.test` event to the endpoint now and returns the delivery with the answer of your server. It makes one attempt and never retries, and it does not count as a failure. It works while the endpoint is paused, so you can check it before turning it on, but not when it is disabled (`409 webhook_endpoint_inactive`). The event is signed like every other, so it also tests your signature check. The number of tests per hour for each endpoint is limited (`429 rate_limited`). With a test key nothing is sent: the URL is checked and `simulated` is `true`. 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. Retriable: when the operation itself fails with a `429`, a `5xx` or a temporary `409`, the key is released and a retry with the same key runs the operation again; with no response at all, a retry with the same key returns the first outcome or runs the operation again. 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/test

## 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`.

## Response

### 200

Successful response.

- `object` ("webhook_delivery", required) — Always `webhook_delivery`.
- `id` (string, required) — Id of the delivery: use it in `GET /webhook-deliveries/{delivery_id}`.
- `endpoint_id` (string, required) — Id of the endpoint the delivery was sent to.
- `event_id` (string, required) — Id of the event. It is the same on every attempt and on a resend, and it is the `VoxAI-Event-Id` header: use it to ignore an event you already processed.
- `event_type` (string, required) — The type of the event, for example `call.ended`; `webhook.test` for a test event.
- `status` (enum, required) — `pending`: waiting for the next attempt. `delivered`: your server answered with a 2xx status. `failed`: every attempt failed and no more will be made. `discarded`: the feature was switched off before it was sent.
  - Allowed values: `pending`, `delivered`, `failed`, `discarded`
- `attempts` (integer, required) — Number of attempts made so far. A test or a resend is one attempt.
- `next_attempt_at` (datetime, required, nullable) — When the next attempt is due, ISO 8601 UTC. `null` unless `status` is `pending`, and always `null` for a test or a resend.
- `last_http_status` (integer, required, nullable) — HTTP status of the last answer of your server; `null` if it did not answer.
- `last_error` (string, required, nullable) — A short safe code for the last failure, `null` if the last attempt succeeded: `http_<status>` (for example `http_503`), `timeout`, `network`, `dns`, `address_not_allowed`, `port_not_allowed`, `internal_error`, `feature_not_available`, `expired`, `attempt_lost`, `error`. Never text from your server.
- `duration_ms` (integer, required, nullable) — How long the last attempt took, in milliseconds; `null` if there was none.
- `manual` (boolean, required) — A test event or a resend: it counts neither as a failure nor towards the automatic disabling (a success resets the counter).
- `resend_of` (string, required, nullable) — Id of the delivery this one is a resend of; `null` if it is not a resend.
- `includes_transcript` (boolean, required) — `true` if the body carries the transcript of the call.
- `created_at` (datetime, required) — When the delivery was created, ISO 8601 UTC.
- `completed_at` (datetime, required, nullable) — When the delivery reached its outcome, ISO 8601 UTC; `null` while it is `pending`.
- `simulated` (boolean, required) — true with a test key: the request was validated and NOT sent.
- `request_body` (string, required, nullable) — The exact JSON text that was signed and sent, while it is still kept (7 days after the outcome). `null` after that, and for a key without the read scope of the event family.
- `response_body_truncated` (string, required, nullable) — At most the first 1 KiB of your server's answer, if it sent any. `null` for a key without the read scope of the event family.

## 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: * `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. * `webhook_endpoint_inactive`: The endpoint is paused or disabled. Reactivate it with `PATCH /webhook-endpoints/{endpoint_id}` and `status: active`, unless it was disabled by VoxAI staff (`disabled_reason: platform`).

- `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. - `service_unavailable`: A component the operation depends on is temporarily unavailable. Retry after a few seconds. For writes marked as retriable, use the same `Idempotency-Key`; for the other writes, first read the state of the resource, then retry with a NEW key only if the operation did not happen. - `webhook_internal_error`: The delivery could not be signed because of a problem on our side. Nothing was sent. Retry later; if it persists, rotate the signing secret. - `webhook_send_not_recorded`: The request was sent but its outcome could not be recorded. Your server may have received it: deduplicate on the `VoxAI-Event-Id` header. Retry shortly if needed. - `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`).

## Examples

**Response**

```json
{
  "object": "webhook_delivery",
  "id": "2f6a9c04-8e31-4b57-a0d2-6c4b1e7f3a85",
  "endpoint_id": "3b9e5a71-6c2d-4f48-b0a3-8d1e7c4f2a96",
  "event_id": "5e2b8d47-1a93-4c60-b7f4-0d9a6c3e8b12",
  "event_type": "webhook.test",
  "status": "delivered",
  "attempts": 1,
  "next_attempt_at": null,
  "last_http_status": 200,
  "last_error": null,
  "duration_ms": 142,
  "manual": true,
  "resend_of": null,
  "includes_transcript": false,
  "created_at": "2026-11-16T10:02:11Z",
  "completed_at": "2026-11-16T10:02:11Z",
  "simulated": false,
  "request_body": "{\"id\":\"5e2b8d47-1a93-4c60-b7f4-0d9a6c3e8b12\",\"object\":\"event\",\"type\":\"webhook.test\",\"api_version\":\"2026-10-01\",\"created_at\":\"2026-11-16T10:02:11Z\",\"organization_id\":\"8d4e1f2a-6b3c-4d5e-8f7a-9b0c1d2e3f4a\",\"data\":{\"object\":{\"object\":\"webhook_test\",\"endpoint_id\":\"3b9e5a71-6c2d-4f48-b0a3-8d1e7c4f2a96\",\"message\":\"This is a test event sent by VoxAI.\"}}}",
  "response_body_truncated": "ok"
}
```

**SDK Code**

```python
import requests

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

headers = {
    "Idempotency-Key": "3f1c9a72-5d4e-4b8a-9c6f-0e2d7a1b4c58",
    "Authorization": "Bearer <token>"
}

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

print(response.json())
```

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

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"
	"net/http"
	"io"
)

func main() {

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

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

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

	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/test")

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>'

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/test")
  .header("Idempotency-Key", "3f1c9a72-5d4e-4b8a-9c6f-0e2d7a1b4c58")
  .header("Authorization", "Bearer <token>")
  .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/test', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    '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/test");
var request = new RestRequest(Method.POST);
request.AddHeader("Idempotency-Key", "3f1c9a72-5d4e-4b8a-9c6f-0e2d7a1b4c58");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Idempotency-Key": "3f1c9a72-5d4e-4b8a-9c6f-0e2d7a1b4c58",
  "Authorization": "Bearer <token>"
]

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

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()
```