Webhooks

Create a webhook endpoint

Add an endpoint. The response includes its signing secret: store it now, it is not shown again.

Creating an endpoint for a URL the account already has is safe to retry: instead of a duplicate, you get that endpoint back (status 200) with the new events added, switched on, and its existing secret.

post/webhook-endpoints

Request

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

Request body

urlstring uri required

A public HTTPS URL.

eventsWebhookEvent[] required

The events to send, at least one. The key needs the read scope of each event's record: lead.created needs leads:read, call.completed, call.missed and message.taken need calls:read, booking.created needs bookings:read, outbound_call.completed needs outbound:read (or outbound:write), every chat.* event needs chats:read, and chat.lead_captured also needs leads:read.

descriptionstring nullable

Example request

{
  "url": "https://hooks.example.com/vocenya",
  "description": "Our CRM"
}

Response

The account already had an endpoint for this URL: that endpoint, with the events added, and its secret.

secretstring required

Example response

{
  "data": {
    "url": "https://hooks.example.com/vocenya"
  }
}

Changes

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