Skip to main content
WEBHOOK

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

​
webhook-id
string
required

Event id. The same for every retry of this event.

​
webhook-timestamp
string
required

Unix time in seconds when this attempt was signed.

​
webhook-signature
string
required

Space-separated signatures, each v1,.

Body

application/json
​
id
string<uuid>
required

Event id. Also sent as the webhook-id header; use it to ignore duplicates.

​
type
string
required
Allowed value: "contact.created"
​
api_version
string
required
Allowed value: "v1"
​
created_at
string<date-time>
required

ISO 8601 timestamp in UTC.

​
business_id
string<uuid>
required

Stable identifier (UUID).

​
data
object
required

Response

200

Return any 2xx status within 10 seconds to acknowledge the event.