curl https://api.vozagent.ai/v1/webhooks \
-H "Authorization: Bearer <token>"
[
{
"id": "wh-a1b2c3d4-e5f6-a7b8-c9d0",
"url": "https://yourapp.com/webhooks/vozagent",
"events": ["contact.created", "call.completed"],
"is_active": true,
"secret": "whsec_*****",
"created_at": "2024-01-10T09:00:00Z"
},
{
"id": "wh-b2c3d4e5-f6a7-b8c9-d0e1",
"url": "https://zapier.com/hooks/catch/123456",
"events": ["call.started", "call.completed"],
"is_active": true,
"secret": "whsec_*****",
"created_at": "2024-01-12T14:30:00Z"
}
]
Webhooks
List Webhooks
Retrieve a list of all webhook subscriptions.
GET
/
v1
/
webhooks
curl https://api.vozagent.ai/v1/webhooks \
-H "Authorization: Bearer <token>"
[
{
"id": "wh-a1b2c3d4-e5f6-a7b8-c9d0",
"url": "https://yourapp.com/webhooks/vozagent",
"events": ["contact.created", "call.completed"],
"is_active": true,
"secret": "whsec_*****",
"created_at": "2024-01-10T09:00:00Z"
},
{
"id": "wh-b2c3d4e5-f6a7-b8c9-d0e1",
"url": "https://zapier.com/hooks/catch/123456",
"events": ["call.started", "call.completed"],
"is_active": true,
"secret": "whsec_*****",
"created_at": "2024-01-12T14:30:00Z"
}
]
Retrieve your API Key from your VozAgent Dashboard.
Response
Returns an array of webhook subscription objects.string
Unique webhook identifier.
string
Endpoint URL to receive events.
string[]
Events this webhook is subscribed to.
boolean
Whether the webhook is active.
string
Signing secret (masked).
Available Events
| Event | Description |
|---|---|
contact.created | Fired when a new contact is created. |
contact.updated | Fired when a contact is updated. |
call.started | Fired when a call begins. |
call.completed | Fired when a call ends. |
curl https://api.vozagent.ai/v1/webhooks \
-H "Authorization: Bearer <token>"
[
{
"id": "wh-a1b2c3d4-e5f6-a7b8-c9d0",
"url": "https://yourapp.com/webhooks/vozagent",
"events": ["contact.created", "call.completed"],
"is_active": true,
"secret": "whsec_*****",
"created_at": "2024-01-10T09:00:00Z"
},
{
"id": "wh-b2c3d4e5-f6a7-b8c9-d0e1",
"url": "https://zapier.com/hooks/catch/123456",
"events": ["call.started", "call.completed"],
"is_active": true,
"secret": "whsec_*****",
"created_at": "2024-01-12T14:30:00Z"
}
]
Was this page helpful?