Webhooks

Send a test event

Send a signed webhook.test event to this endpoint, with {"message": "..."} as its data. Pass event to get a sample of a real event instead (for example chat.message.created), with made-up data and "sample": true, cut down to ids for HIPAA-mode accounts like the real thing. It is delivered in the background like any other event, even when the endpoint is paused.

curl -X POST https://vocenya.com/api/public/v1/webhook-endpoints/3/test \
  -H "Authorization: Bearer $VOCENYA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"event": "chat.message.created"}'
post/webhook-endpoints/{webhookEndpoint}/test

Request

  • Base URL: https://vocenya.com/api/public/v1
  • URL: https://vocenya.com/api/public/v1/webhook-endpoints/{webhookEndpoint}/test
  • Auth: HTTP bearer

Path parameters

webhookEndpointinteger required

The endpoint id.

Request body

event'lead.created' | 'call.completed' | 'booking.created' | 'chat.handed_off' | 'outbound_call.completed' | 'chat.started' | 'chat.message.created' | 'chat.lead_captured' | 'chat.handoff_requested' | 'chat.closed' | 'call.missed' | 'message.taken' | 'sms.received' | 'sms.sent'

Events a client can subscribe a webhook endpoint to.

Response

The queued delivery.

Example response

{
  "data": {
    "event": "lead.created"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.