akadmin/chatwoot
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

update portal payload for developer docs

Browse Source
This commit is contained in:
Tanmay Deep Sharma
2025-05-15 15:30:40 +07:00
parent 073e32770f
commit dc9e19a122
6 changed files with 369 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
swagger/definitions/resource/portal_single.yml
+6
View File
@@ -0,0 +1,6 @@
type: object
properties:
payload:
type: object
description: A single portal object (for show/update endpoints)
$ref: '#/components/schemas/portal_item'
swagger/paths/application/automation_rule/show.yml
+20
View File
@@ -19,6 +19,26 @@ responses:
application/json:
schema:
$ref: '#/components/schemas/automation_rule'
example:
payload:
id: 90
account_id: 1
name: "add-label-bug-if-message-contains-bug"
description: "add-label-bug-if-message-contains-bug"
event_name: "message_created"
conditions:
- values: ["incoming"]
attribute_key: "message_type"
query_operator: "and"
filter_operator: "equal_to"
- values: ["bug"]
attribute_key: "content"
filter_operator: "contains"
actions:
- action_name: "add_label"
action_params: ["bugs", "support-query"]
created_on: 1650555440
active: true
'401':
description: Unauthorized
content:
swagger/paths/application/portal/index.yml
+39 -4
View File
@@ -13,10 +13,45 @@ responses:
content:
application/json:
schema:
type: array
description: Array of all portals
items:
$ref: '#/components/schemas/portal'
$ref: '#/components/schemas/portal'
example:
payload:
- id: 4
color: "#1F93FF"
custom_domain: "chatwoot.help"
header_text: "Handbook"
homepage_link: "https://www.chatwoot.com"
name: "Handbook"
page_title: "Handbook"
slug: "handbook"
archived: false
account_id: 1
config:
allowed_locales:
- code: "en"
articles_count: 32
categories_count: 9
inbox:
id: 37
avatar_url: "https://example.com/avatar.png"
channel_id: 1
name: "Chatwoot"
channel_type: "Channel::WebWidget"
greeting_enabled: true
widget_color: "#1F93FF"
website_url: "chatwoot.com"
logo:
id: 19399916
portal_id: 4
file_type: "image/png"
account_id: 1
file_url: "https://example.com/logo.png"
blob_id: 21239614
filename: "square.png"
meta:
all_articles_count: 0
categories_count: 9
default_locale: "en"
'403':
description: Access denied
content:
swagger/paths/application/portal/show.yml
+79
View File
@@ -0,0 +1,79 @@
tags:
- Help Center
operationId: get-details-of-a-single-portal
summary: Get a portal details
description: Get the details of a portal in the account
security:
- userApiKey: []
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/portal_id'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/portal_single'
example:
payload:
id: 123
archived: false
color: "#1F93FF"
config:
allowed_locales:
- code: "en"
articles_count: 32
categories_count: 9
custom_domain: "chatwoot.help"
header_text: "Handbook"
homepage_link: "https://www.chatwoot.com"
name: "Handbook"
slug: "handbook"
page_title: "Handbook"
account_id: 123
inbox:
id: 123
name: "Chatwoot"
website_url: "chatwoot.com"
channel_type: "Channel::WebWidget"
avatar_url: "https://example.com/avatar.png"
widget_color: "#1F93FF"
website_token: "4cWzuf9i9jxN9tbnv8K9STKU"
enable_auto_assignment: true
web_widget_script: "<script>...</script>"
welcome_title: "Hi there ! 🙌🏼"
welcome_tagline: "We make it simple to connect with us."
greeting_enabled: true
greeting_message: "Hey there 👋, Thank you for reaching out to us."
channel_id: 123
working_hours_enabled: true
enable_email_collect: true
csat_survey_enabled: true
timezone: "America/Los_Angeles"
business_name: "Chatwoot"
hmac_mandatory: true
logo:
id: 123
portal_id: 123
file_type: "image/png"
account_id: 123
file_url: "https://example.com/logo.png"
blob_id: 123
filename: "square.png"
meta:
all_articles_count: 32
categories_count: 9
default_locale: "en"
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'
'404':
description: The given portal ID does not exist in the account
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'
swagger/paths/application/portal/update.yml
+60 -1
View File
@@ -5,6 +5,9 @@ summary: Update a portal
description: Update a portal to account
security:
- userApiKey: []
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/portal_id'
requestBody:
required: true
content:
@@ -17,10 +20,66 @@ responses:
content:
application/json:
schema:
$ref: '#/components/schemas/portal'
$ref: '#/components/schemas/portal_single'
example:
payload:
id: 123
archived: false
color: "#1F93FF"
config:
allowed_locales:
- code: "en"
articles_count: 32
categories_count: 9
custom_domain: "chatwoot.help"
header_text: "Handbook"
homepage_link: "https://www.chatwoot.com"
name: "Handbook"
slug: "handbook"
page_title: "Handbook"
account_id: 123
inbox:
id: 123
name: "Chatwoot"
website_url: "chatwoot.com"
channel_type: "Channel::WebWidget"
avatar_url: "https://example.com/avatar.png"
widget_color: "#1F93FF"
website_token: "4cWzuf9i9jxN9tbnv8K9STKU"
enable_auto_assignment: true
web_widget_script: "<script>...</script>"
welcome_title: "Hi there ! 🙌🏼"
welcome_tagline: "We make it simple to connect with us."
greeting_enabled: true
greeting_message: "Hey there 👋, Thank you for reaching out to us."
channel_id: 123
working_hours_enabled: true
enable_email_collect: true
csat_survey_enabled: true
timezone: "America/Los_Angeles"
business_name: "Chatwoot"
hmac_mandatory: true
logo:
id: 123
portal_id: 123
file_type: "image/png"
account_id: 123
file_url: "https://example.com/logo.png"
blob_id: 123
filename: "square.png"
meta:
all_articles_count: 32
categories_count: 9
default_locale: "en"
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'
'404':
description: Portal not found
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'
swagger/swagger.json
+165 -6
View File
@@ -3472,6 +3472,43 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/automation_rule"
},
"example": {
"payload": {
"id": 90,
"account_id": 1,
"name": "add-label-bug-if-message-contains-bug",
"description": "add-label-bug-if-message-contains-bug",
"event_name": "message_created",
"conditions": [
{
"values": [
"incoming"
],
"attribute_key": "message_type",
"query_operator": "and",
"filter_operator": "equal_to"
},
{
"values": [
"bug"
],
"attribute_key": "content",
"filter_operator": "contains"
}
],
"actions": [
{
"action_name": "add_label",
"action_params": [
"bugs",
"support-query"
]
}
],
"created_on": 1650555440,
"active": true
}
}
}
}
@@ -3696,11 +3733,56 @@
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "Array of all portals",
"items": {
"$ref": "#/components/schemas/portal"
}
"$ref": "#/components/schemas/portal"
},
"example": {
"payload": [
{
"id": 4,
"color": "#1F93FF",
"custom_domain": "chatwoot.help",
"header_text": "Handbook",
"homepage_link": "https://www.chatwoot.com",
"name": "Handbook",
"page_title": "Handbook",
"slug": "handbook",
"archived": false,
"account_id": 1,
"config": {
"allowed_locales": [
{
"code": "en",
"articles_count": 32,
"categories_count": 9
}
]
},
"inbox": {
"id": 37,
"avatar_url": "https://example.com/avatar.png",
"channel_id": 1,
"name": "Chatwoot",
"channel_type": "Channel::WebWidget",
"greeting_enabled": true,
"widget_color": "#1F93FF",
"website_url": "chatwoot.com"
},
"logo": {
"id": 19399916,
"portal_id": 4,
"file_type": "image/png",
"account_id": 1,
"file_url": "https://example.com/logo.png",
"blob_id": 21239614,
"filename": "square.png"
},
"meta": {
"all_articles_count": 0,
"categories_count": 9,
"default_locale": "en"
}
}
]
}
}
}
@@ -3741,6 +3823,14 @@
]
}
],
"parameters": [
{
"$ref": "#/components/parameters/account_id"
},
{
"$ref": "#/components/parameters/portal_id"
}
],
"requestBody": {
"required": true,
"content": {
@@ -3757,7 +3847,66 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/portal"
"$ref": "#/components/schemas/portal_single"
},
"example": {
"payload": {
"id": 123,
"archived": false,
"color": "#1F93FF",
"config": {
"allowed_locales": [
{
"code": "en",
"articles_count": 32,
"categories_count": 9
}
]
},
"custom_domain": "chatwoot.help",
"header_text": "Handbook",
"homepage_link": "https://www.chatwoot.com",
"name": "Handbook",
"slug": "handbook",
"page_title": "Handbook",
"account_id": 123,
"inbox": {
"id": 123,
"name": "Chatwoot",
"website_url": "chatwoot.com",
"channel_type": "Channel::WebWidget",
"avatar_url": "https://example.com/avatar.png",
"widget_color": "#1F93FF",
"website_token": "4cWzuf9i9jxN9tbnv8K9STKU",
"enable_auto_assignment": true,
"web_widget_script": "<script>...</script>",
"welcome_title": "Hi there ! 🙌🏼",
"welcome_tagline": "We make it simple to connect with us.",
"greeting_enabled": true,
"greeting_message": "Hey there 👋, Thank you for reaching out to us.",
"channel_id": 123,
"working_hours_enabled": true,
"enable_email_collect": true,
"csat_survey_enabled": true,
"timezone": "America/Los_Angeles",
"business_name": "Chatwoot",
"hmac_mandatory": true
},
"logo": {
"id": 123,
"portal_id": 123,
"file_type": "image/png",
"account_id": 123,
"file_url": "https://example.com/logo.png",
"blob_id": 123,
"filename": "square.png"
},
"meta": {
"all_articles_count": 32,
"categories_count": 9,
"default_locale": "en"
}
}
}
}
}
@@ -3771,6 +3920,16 @@
}
}
}
},
"404": {
"description": "Portal not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/bad_request_error"
}
}
}
}
}
}