Webhooks

Create an endpoint

POSThttps://voxa.abhinavyadav.in/api/v1/webhooks

Registers a URL to receive call events. The signing secret is in this response only: store it to verify signatures. At most 20 endpoints per workspace.

Authorization

An API key (X-API-Key or Authorization: Bearer), or a signed-in member with the keys.manage permission.

X-API-KeyAuthorization: Bearerkeys.manage

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Body application/json

urlstringrequired

A public https:// URL.

at most 500 characters

descriptionstring

A note for your team.

at most 200 characters

eventsstring[]

Event types to receive, or ["*"] for all. See List event types.

activebooleandefault: true

Inactive endpoints receive nothing.

Response

201Success.

See the 201 example next to the code samples.

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

429Over the per-key rate limit; wait for Retry-After.

detailstring

What went wrong, in plain words.

curl --request POST \
  --url 'https://voxa.abhinavyadav.in/api/v1/webhooks?timezone=Asia/Kolkata' \
  --header 'X-API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://example.com/voxa/events",
  "description": "CRM sync",
  "events": [
    "call.completed"
  ],
  "active": true
}'

import requests

url = "https://voxa.abhinavyadav.in/api/v1/webhooks"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "X-API-Key": "<api-key>",
}
payload = {
    "url": "https://example.com/voxa/events",
    "description": "CRM sync",
    "events": [
        "call.completed",
    ],
    "active": True,
}

response = requests.post(url, params=params, headers=headers, json=payload)
print(response.status_code, response.json())

const response = await fetch("https://voxa.abhinavyadav.in/api/v1/webhooks?timezone=Asia/Kolkata", {
  method: "POST",
  headers: {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "url": "https://example.com/voxa/events",
    "description": "CRM sync",
    "events": [
      "call.completed"
    ],
    "active": true
  }),
})
const data = await response.json()
console.log(response.status, data)

Response

{
  "id": "we_6f1d2c3b4a5e4f60a1b2c3d4e5f60718",
  "url": "https://example.com/voxa/events",
  "description": "CRM sync",
  "events": [
    "call.completed"
  ],
  "active": true,
  "secret_hint": "whsec_…9f2a",
  "created_at": "2026-09-30T15:42:00+05:30",
  "created_by": "Rohan",
  "secret": "whsec_3b0f…"
}

{
  "detail": "sign in required"
}

{
  "detail": "your role cannot do this (keys.manage)"
}

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "body",
        "name"
      ],
      "msg": "Field required",
      "input": {}
    }
  ]
}

{
  "detail": "rate limit exceeded; slow down"
}