/
ON
onboard
/
Onboard API - Complete Specification
Search skmtc…
⌘K
Changes
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 2h ago · Updated 22h ago
Details
Filter operations
Activity
2
Assets
12
Billing
2
Bots
66
get
GET /bots
post
POST /bots
options
OPTIONS /bots
get
GET /bots/stats
options
OPTIONS /bots/stats
get
GET /bots/{id}
put
PUT /bots/{id}
delete
DELETE /bots/{id}
options
OPTIONS /bots/{id}
patch
PATCH /bots/{id}
post
POST /bots/{id}/unarchive
options
OPTIONS /bots/{id}/unarchive
get
GET /bots/{id}/tokens
post
POST /bots/{id}/tokens
options
OPTIONS /bots/{id}/tokens
delete
DELETE /bots/{id}/tokens/{id}
options
OPTIONS /bots/{id}/tokens/{id}
get
GET /widgets
post
POST /widgets
options
OPTIONS /widgets
get
GET /widgets/{id}
put
PUT /widgets/{id}
options
OPTIONS /widgets/{id}
patch
PATCH /widgets/{id}
get
GET /widget.js
options
OPTIONS /widget.js
get
GET /widget-config
options
OPTIONS /widget-config
get
GET /widget-tasks
options
OPTIONS /widget-tasks
get
GET /core-knowledge
put
PUT /core-knowledge
options
OPTIONS /core-knowledge
get
GET /conversation-trends
options
OPTIONS /conversation-trends
get
GET /faq-suggestions
post
POST /faq-suggestions
options
OPTIONS /faq-suggestions
get
GET /faq-suggestions/{id}
put
PUT /faq-suggestions/{id}
delete
DELETE /faq-suggestions/{id}
options
OPTIONS /faq-suggestions/{id}
patch
PATCH /faq-suggestions/{id}
get
GET /chat-settings
put
PUT /chat-settings
options
OPTIONS /chat-settings
post
POST /page-view
options
OPTIONS /page-view
get
GET /page-views
options
OPTIONS /page-views
get
GET /bot-tasks
post
POST /bot-tasks
options
OPTIONS /bot-tasks
get
GET /bot-tasks/{id}
put
PUT /bot-tasks/{id}
delete
DELETE /bot-tasks/{id}
options
OPTIONS /bot-tasks/{id}
patch
PATCH /bot-tasks/{id}
get
GET /bot-tasks/{id}/chips
post
POST /bot-tasks/{id}/chips
options
OPTIONS /bot-tasks/{id}/chips
get
GET /bot-tasks/{id}/chips/{id}
put
PUT /bot-tasks/{id}/chips/{id}
delete
DELETE /bot-tasks/{id}/chips/{id}
options
OPTIONS /bot-tasks/{id}/chips/{id}
patch
PATCH /bot-tasks/{id}/chips/{id}
Comments
22
Communication Records
18
Conversations
14
Custom
14
Email
25
Forms
15
Hooks
12
Knowledge Base
23
Map
271
Platform
105
Stats
46
Workflows
32
Bots
OPTIONS /widgets/{id}
OPTIONS operation for /widgets/{id}
options
/widgets/{id}
Path parameters
id
string
required
Response
Successful response
WidgetSerializer
required
id
integer
bot
string
required
mode
'light'
|
'dark'
position
'bottom_left'
|
'bottom_right'
bot_logo_url
string
bot_logo
string
binary
header_text
string
welcome_message
string
show_powered_by
boolean
is_email_required
boolean
primary_color
string
header_text_color
string
background_color
string
bot_message_bg
string
bot_message_text
string
user_message_bg
string
user_message_text
string
created_at
string
date-time
modified_at
string
date-time
Changes