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.

POST/v1/webhooks/{endpoint_id}/testSend a sample event now.

Your API key, scope setup or all. On the card: events. Every call here is a checked sample.

Request2 fields

Path

endpoint_idstringrequiredThe webhook endpoint's id (whk_...).

Type: string

Headers

Idempotency-KeystringSend the same key to retry this call safely for 24 hours.

Type: string

Answers 2004 fields

okbooleanWhether your endpoint answered 2xx to a signed webhook.test event.

Type: boolean

status_codeinteger | nullWhat it answered; null when it did not answer.

Type: integer | null

duration_msintegerHow long it took, in milliseconds: 10 seconds at most.

Type: integer

errorstring | nullWhat went wrong, such as a timeout; null when it answered.

Type: string | null

HTTP

# Register your endpoint and the events it wants. The signing secret is in the answer, shown once.curl "$VESTRA_BASE_URL/v1/webhooks" \  -H "Authorization: Bearer $VESTRA_API_KEY" \  -H "Content-Type: application/json" \  -d '{ "url": "https://hooks.example.com/vestra", "events": ["task.completed", "interaction.created"] }' # Send a sample event now, to see your endpoint answer.curl -X POST "$VESTRA_BASE_URL/v1/webhooks/whk_9sd/test" \  -H "Authorization: Bearer $VESTRA_API_KEY"

HTTP

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

# Register your endpoint and the events it wants. The signing secret is in the answer, shown once.curl "$VESTRA_BASE_URL/v1/webhooks" \  -H "Authorization: Bearer $VESTRA_API_KEY" \  -H "Content-Type: application/json" \  -d '{ "url": "https://hooks.example.com/vestra", "events": ["task.completed", "interaction.created"] }' # Send a sample event now, to see your endpoint answer.curl -X POST "$VESTRA_BASE_URL/v1/webhooks/whk_9sd/test" \  -H "Authorization: Bearer $VESTRA_API_KEY"