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

Name	Label	Type	Description	Required
message	Message	STRING	The message of the response.	null
attachments	Attachments	ARRAY Items [FILE_ENTRY]	The attachments of the response.	null

Example JSON Structure

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

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Triggers

New Chat Request

Name: newChatRequest

.

Type: STATIC_WEBHOOK

Properties

Name	Label	Type	Description	Required
mode		INTEGER Options 1, 2		true

Output

Type: OBJECT

Properties

Name	Type	Description
conversationId	STRING
message	STRING
attachments	ARRAY Items [FILE_ENTRY]

JSON Example

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

---