Skip to main content
POST
/
api
/
v1
/
agent
/
{agent_id}
/
webhook
/
test
Test Webhook
curl --request POST \
  --url https://dev.voice.ai/api/v1/agent/{agent_id}/webhook/test \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "message": "<string>",
  "attempts": 123,
  "error": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Use your API key as the bearer token. Format: Authorization: Bearer

Path Parameters

​
agent_id
string<uuid>
required

The agent ID to test webhooks for

Response

Webhook test result

Response from webhook test endpoint

​
status
enum<string>
required

Test result status

Available options:
success,
failed
​
message
string
required

Human-readable result description

​
attempts
integer
required

Number of delivery attempts made

​
error
string | null

Error details if the test failed