Skip to main content
POST
Add the chat widget to a website

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. Only platform keys can hold businesses:create and users:create.

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.

Idempotency-Key
string

A unique value, up to 255 characters, that makes retries of this request safe for 24 hours.

Maximum string length: 255

Body

application/json
allowed_origins
string<uri>[]
required

The websites the widget may run on, as full http or https URLs. Only each one's origin is kept.

Maximum array length: 50
Maximum string length: 2000
label
string
Required string length: 1 - 120
config
object

How the widget looks and behaves.

Response

Created

data
object
required

A new widget key, with the script tag that adds the widget to a website.