Skip to content

Chat

Actions and triggers for using with the chat widget.

Categories: helpers

Type: chat/v1


Actions

Response to Chat Request

Name: responseToRequest

Converts the response to chat request.

Properties

NameLabelTypeControl TypeDescriptionRequired
messageMessageSTRINGTEXTThe message of the response.null
attachmentsAttachmentsARRAY
Items [FILE_ENTRY]
ARRAY_BUILDERThe attachments of the response.null

JSON Example

{
"label" : "Response to Chat Request",
"name" : "responseToRequest",
"parameters" : {
"message" : "",
"attachments" : [ {
"extension" : "",
"mimeType" : "",
"name" : "",
"url" : ""
} ]
},
"type" : "chat/v1/responseToRequest"
}

Triggers

New Chat Request

Name: newChatRequest

.

Type: STATIC_WEBHOOK

Properties

NameLabelTypeControl TypeDescriptionRequired
modeINTEGER
Options 1, 2
SELECTtrue

Output

Type: OBJECT

Properties

NameTypeControl Type
conversationIdSTRINGTEXT
messageSTRINGTEXT
attachmentsARRAY
Items [FILE_ENTRY]
ARRAY_BUILDER

JSON Example

{
"label" : "New Chat Request",
"name" : "newChatRequest",
"parameters" : {
"mode" : 1
},
"type" : "chat/v1/newChatRequest"
}