Skip to content

Create Webchat Button

POST
/webchat/buttons

Add a quick-action button.

value is read according to action: a URL for link, the question text for question, a calendar slug for calendar.

Authorizations

Parameters

Header Parameters

Idempotency-Key
Any of:
string
>= 16 characters <= 128 characters

Retry-safety key for this create. Replaying the same key returns the FIRST result instead of creating a second row. Durability depends on the tenant’s migration state, so treat it as best-effort.

X-Target-Org-Id
Any of:
string

Request Body required

A quick-action button in the widget.

value means something different per action: a URL for link, the question text for question, a calendar slug for calendar. Sending the wrong kind is accepted here and fails at the widget, so it is spelled out rather than left to be discovered.

object
action
required
string
Allowed values: link question calendar
active
boolean
default: true
category
required
string
>= 1 characters <= 100 characters
chat_bot_id
required

Owning chat bot id (UUID).

string
icon
Any of:
string
<= 100 characters
label
required
string
>= 1 characters <= 255 characters
paths

URL paths where the button appears.

Array<string>
surface
Any of:
string
Allowed values: external internal
value
required

URL for link, question text for question, slug for calendar.

string
>= 1 characters <= 1000 characters

Responses

201

Successful Response

object
data
required

An open envelope for one webchat object.

Open because the widget’s config grows a field per product decision and a pinned schema would DROP it. Same choice the desk surface made.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string