DialerBee APIv1 · 1.0.0-rc6

Webhooks

Change a webhook endpoint

PATCH /v1/webhooks/{webhook_id}

Scope
webhooks:write
Tier
Tier 1
Data
Account data
Idempotency
Idempotency-Key: optional

Parameters

NameInTypeRequiredDescription
webhook_idpathstring (WebhookEndpointId)yes
Idempotency-KeyheaderstringnoOptional here. When sent, it behaves exactly as on the operations that require it. (min length 1; max length 255)
X-Correlation-IDheaderstringnoYour own trace value, logged with the request. Metadata only, never identity. (min length 1; max length 128)

Request body

The fields to change.

JSON: WebhookEndpointUpdateRequest

Response

200: The endpoint.

HeaderMeaning
X-Request-IDThe DialerBee request id. Quote it to support. Every response carries X-Request-ID: req_<ULID>, or edge_<32 hex> when the edge answered before the request reached the API.
Cache-ControlAlways no-store.
Idempotency-Replayedtrue when this answer is the stored answer of an earlier request with the same Idempotency-Key.

Examples

Request example

curl

curl -sS -X PATCH \
  "https://app.dialerbee.com/api/v1/webhooks/wh_0f8fad5b-d9cb-469f-a165-70867728950e" \
  -H "Authorization: Bearer $DIALERBEE_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "events": [
    "call.completed",
    "ai_call.completed"
  ]
}'

Python (SDK)

from dialerbee import DialerBee

db = DialerBee()  # reads DIALERBEE_API_KEY from the environment

result = db.webhooks.update(
    "wh_0f8fad5b-d9cb-469f-a165-70867728950e",
    events=["call.completed", "ai_call.completed"],
)

Response example

200

{
  "id": "wh_0f8fad5b-d9cb-469f-a165-70867728950e",
  "url_preview": "https://crm.example.com/dialerbee/...",
  "host": "crm.example.com",
  "description": "CRM sync",
  "events": [
    "call.completed"
  ],
  "enabled": true,
  "secret_hint": "safe",
  "created_at": "2026-09-29T09:15:00Z",
  "updated_at": "2026-09-29T09:20:00Z"
}

Error examples

403 webhooks_disabled

{
  "type": "https://docs.dialerbee.com/errors/webhooks-disabled",
  "title": "Webhooks not enabled",
  "status": 403,
  "detail": "Webhooks are not switched on for this account.",
  "instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "code": "webhooks_disabled",
  "request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}

422 webhook_url_refused

{
  "type": "https://docs.dialerbee.com/errors/webhook-url-refused",
  "title": "Webhook URL refused",
  "status": 422,
  "detail": "The webhook URL must be https://, must resolve to a public address, and must not point to a private, loopback, link-local or cloud-metadata address.",
  "instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "code": "webhook_url_refused",
  "request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}

403 insufficient_scope

{
  "type": "https://docs.dialerbee.com/errors/insufficient-scope",
  "title": "Not permitted",
  "status": 403,
  "detail": "The API client does not hold the scope this operation requires.",
  "instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "code": "insufficient_scope",
  "request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}

Errors

StatusCodeTitle
401invalid_api_keyInvalid API key
403api_access_disabledAPI access disabled
403ip_not_allowedIP address not allowed
403insufficient_scopeNot permitted
400credential_in_urlCredential in URL
400credential_in_bodyCredential in body
400, 422validation_failedInvalid request
413payload_too_largePayload too large
415unsupported_media_typeUnsupported media type
404not_foundNot found
403webhooks_disabledWebhooks not enabled
422webhook_url_refusedWebhook URL refused
409conflictRequest in progress
409idempotency_conflictIdempotency key reused
409outcome_unknownOutcome unknown
429rate_limit_exceededToo many requests
503temporarily_unavailableTemporarily unavailable
503upstream_unavailableTemporarily unavailable
502upstream_invalid_responseUpstream error
500internal_errorInternal error

Objects

WebhookEndpointUpdateRequest

FieldTypeRequiredDescription
urlstring (uri)no (min length 9; max length 2048; https only)
eventsarray of one of call.completed, ai_call.completed, disposition.logged, appointment.booked, appointment.moved, appointment.cancelledno (min items 1; max items 6)
descriptionstringno (max length 200)
enabledbooleanno

WebhookEndpoint

FieldTypeRequiredDescription
idstring (WebhookEndpointId)yesA webhook endpoint. wh_ + a lower-case UUID.
url_previewstringyesThe URL with its path and query shortened; the full URL is never shown again.
hoststringyes
descriptionstringyes
eventsarray of one of call.completed, ai_call.completed, disposition.logged, appointment.booked, appointment.moved, appointment.cancelledyes
enabledbooleanyes
secret_hintstringyesThe last four characters of the current secret.
created_atstring (date-time)yes
updated_atstring (date-time)yes