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

# List event types

GET https://api.getvoxai.com/v1/webhook-event-types

Returns the event types you can subscribe an endpoint to, each with a description, the read scope a key needs to subscribe to it and whether the endpoint can ask for the transcript on it. `reserved` lists names that are taken but not emitted yet: subscribing to one gives `422 unknown_event_type`. The list is not paged. Subscribing to `*` is not possible: choose the types one by one. Required scope: `webhooks:manage`. With a test key (`vx_test_`) it behaves exactly as with a live key and consumes nothing.

Reference: https://docs.getvoxai.com/api-reference/webhooks/event-types

## Authentication

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

## Request

### Headers

- `VoxAI-Version` (enum, optional) — API version for this request; defaults to the version the key is pinned to.
  - Allowed values: `2026-10-01`

## Response

### 200

Successful response.

- `data` (list of WebhookEventTypesGetResponsesContentApplicationJsonSchemaDataItems, required) — The event types you can subscribe to.
- `reserved` (list of WebhookEventTypesGetResponsesContentApplicationJsonSchemaReservedItems, required) — Names that are taken but not emitted yet: subscribing to them gives `unknown_event_type`.
- `has_more` (boolean, required) — Always `false`: the list is not paged.
- `next_cursor` (any, required) — Always `null`: the list is not paged.

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

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

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

### WebhookEventTypesGetResponsesContentApplicationJsonSchemaDataItems

- `object` ("webhook_event_type", required) — Always `webhook_event_type`.
- `type` (enum, required) — The name of the event type, to use in `events`. `call.started`: A call has started. `call.ended`: A call has ended (completed, interrupted or failed). `call.missed`: An inbound call was not answered (lines busy, quota exhausted, organization suspended, platform busy). `call.analyzed`: The report card, collected data and summary of a call are ready. `call.transferred`: A call was transferred to a person who answered. `campaign.started`: A campaign has started (or resumed). `campaign.paused`: A campaign has been paused. `campaign.completed`: A campaign has completed. `campaign.contact.completed`: A campaign contact has reached a final outcome. `knowledge.document.indexed`: A knowledge base document is ready. `knowledge.document.failed`: A knowledge base document could not be indexed. `usage.threshold_reached`: Minutes or SMS for the period (or the annual minutes pool) have reached 80% or 100% of those included. `line.activated`: A phone line has been activated. `line.status_changed`: A phone line has changed status (for example it was released). `caller_request.received`: A caller request has been recorded (access, erasure, objection), also from the app: in that case with status open. `license.changed`: The organization's license has changed: activated, renewed, changed plan, reactivated, expired, suspended for non-payment or cancelled. `license.expiring`: The license is reaching the end of its period: the same notice the Owners receive by email. `payment.failed`: The subscription charge has failed: the service continues until the end of the grace period. `sms.sent`: An agent sent an SMS during a call. `sms.failed`: An agent's SMS was not sent (monthly limit, unsuitable number or rejected by the network), with the reason.
  - Allowed values: `call.started`, `call.ended`, `call.missed`, `call.analyzed`, `call.transferred`, `campaign.started`, `campaign.paused`, `campaign.completed`, `campaign.contact.completed`, `knowledge.document.indexed`, `knowledge.document.failed`, `usage.threshold_reached`, `line.activated`, `line.status_changed`, `caller_request.received`, `license.changed`, `license.expiring`, `payment.failed`, `sms.sent`, `sms.failed`
- `description` (string, required) — What the event means, in English.
- `required_scope` (string, required) — The scope a key needs to subscribe to this type.
- `supports_transcript` (boolean, required) — The endpoint can ask for the transcript on this type.

### WebhookEventTypesGetResponsesContentApplicationJsonSchemaReservedItems

- `type` (string, required) — A name that is taken but not emitted yet.
- `message` (string, required) — Why it cannot be subscribed to yet.

## Examples

**Response**

```json
{
  "data": [
    {
      "object": "webhook_event_type",
      "type": "call.ended",
      "description": "A call has ended (completed, interrupted or failed).",
      "required_scope": "calls:read",
      "supports_transcript": true
    },
    {
      "object": "webhook_event_type",
      "type": "campaign.paused",
      "description": "A campaign has been paused.",
      "required_scope": "campaigns:read",
      "supports_transcript": false
    },
    {
      "object": "webhook_event_type",
      "type": "knowledge.document.indexed",
      "description": "A knowledge base document is ready.",
      "required_scope": "knowledge:read",
      "supports_transcript": false
    }
  ],
  "reserved": [],
  "has_more": false,
  "next_cursor": null
}
```

**SDK Code**

```python
import requests

url = "https://api.getvoxai.com/v1/webhook-event-types"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript
const url = 'https://api.getvoxai.com/v1/webhook-event-types';
const options = {method: 'GET', headers: {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-event-types"

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

	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-event-types")

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

request = Net::HTTP::Get.new(url)
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.get("https://api.getvoxai.com/v1/webhook-event-types")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.getvoxai.com/v1/webhook-event-types', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.getvoxai.com/v1/webhook-event-types");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.getvoxai.com/v1/webhook-event-types")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
```