Webhooks and events

Where events go, how each delivery went, and the record of every event.

Send Authorization: Bearer vk_test_... on every call. Every route of Webhooks and events.

GET/v1/events/{event_id}One event.

Your API key, scope runtime or all. On the card: events. Over HTTP it is made from the contract: fill in each {…} and every value.

Request1 field

Path

event_idstringrequiredThe event's id (evt_...).

Type: string

Answers 2009 fields

idstringThe event (evt_...): the same on every retry, so use it to skip one you already took.

Example: evt_4hq

object"event"Always event.

Type: "event"

typestringAn event a webhook carries: every event of the catalog but the six that ride only the stream (message.delta, task.progress, usage.updated, screen.control, error and ping).

Limits: One of 28 values.
Example: task.completed

mode"live" | "test"The mode it happened in: test or live.

Type: "live" | "test"

created_atstringWhen it happened, as an ISO 8601 time.

Type: string

user_idstring | nullYour id for the user it concerns; null for your company's own Bash, or when it concerns no user.

Type: string | null

task_idstring | nullThe task it concerns (task_...); null when none.

Type: string | null

conversation_idstring | nullThe conversation it concerns (conv_...); null when none.

Type: string | null

datamap of anyWhat it says: its fields depend on its type, as the events reference lists them.

Type: map of any

HTTP

No sample in your language for this route, so here it is over HTTP.

curl "$VESTRA_BASE_URL/v1/events/{event_id}" \  -H "Authorization: Bearer $VESTRA_API_KEY"