Send a signed test delivery
Send one signed sample delivery to a webhook's URL to check that it receives and accepts it, and report the HTTP status and how long it took. The body is { id, event, data: { test: true, workspaceId, timestamp } }. Pass event to label the sample with a real event key; it defaults to "webhook.test". Event keys: conversation.started, conversation.ended, call_log.completed, lead.received, lead.updated, campaign.launched, campaign.scheduled, campaign.paused, campaign.resumed, campaign.completed, campaign.cancelled, campaign.recipient.finished, alert.fired, metric.optimised. Requires workspace-admin.
Authorization
bearerAuth A personal access token from Settings > API tokens.
In: header
Path Parameters
Workspace slug (GET /me lists yours).
Header Parameters
A key you choose, such as a UUID, that makes this POST safe to retry. Within 24 hours the same key and request answers with the first successful answer and runs nothing, the same key with a different request answers 422 idempotency_key_reused, and a key whose request is still running answers 409 idempotency_key_in_use. A failed request keeps nothing, so the same key runs it again.
1 <= length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Event key to put in the sample (default "webhook.test").
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/workspaces/string/webhooks/string/ping" \ -H "Content-Type: application/json" \ -d '{}'{
"webhookId": "string",
"event": "string",
"success": true,
"property1": null,
"property2": null
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}List webhooks GET
List the workspace's outbound webhooks. Each: { id, endpointUrl, events, isActive, description, lastTriggeredAt, hasSecret }. The signing secret is never returned here; it stays visible in Settings → Webhooks. Event keys: conversation.started, conversation.ended, call_log.completed, lead.received, lead.updated, campaign.launched, campaign.scheduled, campaign.paused, campaign.resumed, campaign.completed, campaign.cancelled, campaign.recipient.finished, alert.fired, metric.optimised. Requires workspace-admin.
Send one event to the webhook again POST
Send one event to a webhook again, signed afresh, with the same body and X-VAI-Event-Id as the first time, so a receiver that de-duplicates on the id stays correct. Use it after fixing the receiving end. The eventId comes from list_webhook_deliveries. A body is kept for seven days (less when the workspace or agent keeps call data for less, and not at all in zero data retention); after that the event cannot be redelivered. The new attempt appears in list_webhook_deliveries with redelivery: true. Requires workspace-admin.