Skip to main content
POST
/
v1
/
webhooks
curl -X POST https://api.vozagent.ai/v1/webhooks \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Webhook",
    "url": "https://yourapp.com/webhooks",
    "events": ["contact.created", "call.completed"]
  }'

{
  "id": "wh-new-a1b2c3d4-e5f6-a7b8",
  "url": "https://yourapp.com/webhooks",
  "events": ["contact.created", "call.completed"],
  "is_active": true,
  "secret": "whsec_abc123xyz456...",
  "created_at": "2024-01-15T12:00:00Z"
}
Retrieve your API Key from your VozAgent Dashboard.

​
Body parameters

​
name
string
required
A display name for the webhook subscription.
​
url
string
required
The HTTPS endpoint URL to receive webhook events.
​
events
string[]
required
Array of event types to subscribe to.

​
Available Events

EventDescription
contact.createdNew contact created.
call.startedCall initiated.
call.completedCall ended.
lead.qualifiedLead marked as qualified.
appointment.bookedAppointment booked during a call.
appointment.rescheduledAppointment rescheduled.

​
Response

Returns the created webhook with its signing secret. Store the secret securely — it won’t be shown again. Status code: 201. 
curl -X POST https://api.vozagent.ai/v1/webhooks \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Webhook",
    "url": "https://yourapp.com/webhooks",
    "events": ["contact.created", "call.completed"]
  }'

{
  "id": "wh-new-a1b2c3d4-e5f6-a7b8",
  "url": "https://yourapp.com/webhooks",
  "events": ["contact.created", "call.completed"],
  "is_active": true,
  "secret": "whsec_abc123xyz456...",
  "created_at": "2024-01-15T12:00:00Z"
}