Skip to navigation

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

Authentication

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

Headers

VoxAI-VersionenumOptional

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

Allowed values:

Response

Successful response.
datalist of objects
The event types you can subscribe to.
reservedlist of objects

Names that are taken but not emitted yet: subscribing to them gives unknown_event_type.

has_moreboolean

Always false: the list is not paged.

next_cursorany

Always null: the list is not paged.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error