Skip to main content
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"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.vozagent.ai/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve your API Key from your VozAgent Dashboard.

Response

Returns an array of webhook subscription objects.
id
string
Unique webhook identifier.
url
string
Endpoint URL to receive events.
events
string[]
Events this webhook is subscribed to.
is_active
boolean
Whether the webhook is active.
secret
string
Signing secret (masked).

Available Events

EventDescription
contact.createdFired when a new contact is created.
contact.updatedFired when a contact is updated.
call.startedFired when a call begins.
call.completedFired 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"
  }
]