Chat

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.	false
attachments	Attachments	ARRAY Items [FILE_ENTRY]	The attachments of the response.	false

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

A new chat request comes from the chat interface.

Type: STATIC_WEBHOOK

Properties

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

Output

Type: OBJECT

Properties

Name	Type	Description
conversationId	STRING	Identifier of the conversation the message was posted to.
message	STRING	Text of the message.
attachments	ARRAY Items [FILE_ENTRY]	Files that arrived with the message.

JSON Example

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

On this page