Skip to main content
PATCH
/
v1
/
webhooks
/
{id}
curl -X PATCH https://api.vozagent.ai/v1/webhooks/wh-a1b2c3d4... \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "events": ["call.completed", "appointment.booked"],
    "isActive": true
  }'

{
  "id": "wh-a1b2c3d4-e5f6-a7b8",
  "name": "My Webhook",
  "url": "https://yourapp.com/webhooks",
  "events": ["call.completed", "appointment.booked"],
  "is_active": true,
  "created_at": "2024-01-15T12:00:00Z",
  "updated_at": "2024-01-16T08:30:00Z"
}
Retrieve your API Key from your VozAgent Dashboard.

​
Path parameters

​
id
string
required
The unique identifier of the webhook to update.

​
Body parameters

All fields are optional. Only include the fields you want to change.
​
name
string
Update the webhook display name.
​
url
string
Update the HTTPS endpoint URL to receive webhook events.
​
events
string[]
Replace the list of event types to subscribe to.
​
isActive
boolean
Enable or disable the webhook. Set to false to pause event delivery without deleting the webhook.

​
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 updated webhook object. Status code: 200. 
curl -X PATCH https://api.vozagent.ai/v1/webhooks/wh-a1b2c3d4... \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "events": ["call.completed", "appointment.booked"],
    "isActive": true
  }'

{
  "id": "wh-a1b2c3d4-e5f6-a7b8",
  "name": "My Webhook",
  "url": "https://yourapp.com/webhooks",
  "events": ["call.completed", "appointment.booked"],
  "is_active": true,
  "created_at": "2024-01-15T12:00:00Z",
  "updated_at": "2024-01-16T08:30:00Z"
}