Webhooks

Update an endpoint

PATCHhttps://voxa.abhinavyadav.in/api/v1/webhooks/{endpoint_id}

Changes only the fields you send.

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

Path parameters

endpoint_idstringrequired

The webhook endpoint's id.

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

urlstring | null

at most 500 characters

descriptionstring | null

at most 200 characters

eventsstring[] | null

activeboolean | null

Response

200Success.

See the 200 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 PATCH \
  --url 'https://voxa.abhinavyadav.in/api/v1/webhooks/{endpoint_id}?timezone=Asia/Kolkata' \
  --header 'X-API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "active": false
}'

import requests

url = "https://voxa.abhinavyadav.in/api/v1/webhooks/{endpoint_id}"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "X-API-Key": "<api-key>",
}
payload = {
    "active": False,
}

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

const response = await fetch("https://voxa.abhinavyadav.in/api/v1/webhooks/{endpoint_id}?timezone=Asia/Kolkata", {
  method: "PATCH",
  headers: {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "active": false
  }),
})
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": false,
  "secret_hint": "whsec_…9f2a",
  "created_at": "2026-09-30T15:42:00+05:30",
  "created_by": "Rohan"
}

{
  "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"
}