Skip to main content
PATCH
Update a webhook endpoint

Authorizations

Authorization
string
header
required

An API key from Settings > API keys (lsk_...), which acts on its own business, or a platform key from the PLATFORM_API_KEYS setting (lsp_...), which onboards and manages businesses. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:read, knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage, team:manage, businesses:create, users:create, phone_numbers:purchase, partner:read, partner.businesses:write, partner.demos:write, partner.packages:write, partner.branding:write, partner.templates:write, partner.team:write, partner.billing:read, partner.billing:write. Only platform keys can hold businesses:create and users:create, and only a key a partner made in its console can hold the partner scopes, which the Partner endpoints use. Only a partner's owners grant partner.billing:read and partner.billing:write.

Headers

LobbyStack-Business
string<uuid>

The business a platform key acts on. Required with a platform key. A per-business key may leave it out; if it sends one, it must be the key's own business.

Path Parameters

webhook_id
string<uuid>
required

The webhook endpoint id.

Body

application/json
url
string<uri>

HTTPS URL that receives events.

Maximum string length: 2000
events
enum<string>[]
Minimum array length: 1
Available options:
call.completed,
appointment.booked,
appointment.rescheduled,
appointment.cancelled,
message.taken,
contact.created
description
string | null
Maximum string length: 200
status
enum<string>
Available options:
enabled,
disabled

Response

OK

data
object
required