LiveChat

Interact with LiveChat to manage conversations, send messages, and more.

Triggers

Events from this node that can start a flow. Add one from Choose a trigger.

Conversation Created

Triggered when a new conversation is created

Settings

No settings.

Output

Later steps use this data through Current Trigger in the $ picker. For example, conversation.id is $trigger.output.conversation.id.

json

{
  "conversation": {
    "id": "string",
    "orgId": "string",
    "name": "string",
    "memos": [
      {
        "id": "string",
        "text": "string",
        "created": "string",
        "sender": {}
      }
    ],
    "tags": [
      "string"
    ],
    "status": "string",
    "statusUpdatedAt": "string",
    "created": "string",
    "isAssigned": false,
    "ocsChannel": "string",
    "platform": {},
    "teamId": "string",
    "autoClosedConversation": false
  },
  "message": "string",
  "enduser": {
    "id": "string",
    "recurrent": false
  },
  "team": {
    "id": "string"
  },
  "assignee": {
    "id": "string"
  }
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`conversation`	Any
`conversation.id`	Text	Unique identifier for the conversation
`conversation.orgId`	Text	ID of the organization
`conversation.name`	Text	Name of the conversation
`conversation.memos[]`	List	Array of memos
`conversation.memos[].id`	Text	Unique identifier for the memo
`conversation.memos[].text`	Text	Text of the memo
`conversation.memos[].created`	Text	Timestamp when the memo was created
`conversation.memos[].sender`	Any
`conversation.memos[].sender.id`	Text	Unique identifier for the sender
`conversation.memos[].sender.name`	Text	Name of the sender
`conversation.memos[].sender.email`	Text	Email of the sender
`conversation.tags[]`	List	Array of tags
`conversation.status`	Text	Status of the conversation
`conversation.statusUpdatedAt`	Text	Timestamp when the status was updated
`conversation.created`	Text	Timestamp when the conversation was created
`conversation.isAssigned`	Yes / No	Whether the conversation is assigned
`conversation.ocsChannel`	Text	OCS channel of the conversation
`conversation.platform`	Any
`conversation.platform.name`	Text	Name of the platform
`conversation.platform.channelId`	Text	ID of the channel
`conversation.platform.channelName`	Text	Name of the channel
`conversation.teamId`	Text	ID of the team
`conversation.autoClosedConversation`	Yes / No	Whether the conversation is auto closed
`message`	Any
`message.id`	Text	Unique identifier for the message
`message.from`	Text	Source of the message (e.g., user, bot)
`message.conversationId`	Text	ID of the conversation this message belongs to
`message.type`	Text	Type of the message (e.g., text)
`message.data`	Object	Message data content
`message.data.metadata`	Object	Additional metadata about the message
`message.data.metadata.sender`	Object	Information about the message sender
`message.data.id`	Text	Unique identifier for the message data
`message.data.text`	Text	Text content of the message
`message.data.type`	Text	Type of the message data
`message.sender`	Object	Information about the message sender
`message.sender.name`	Text	Name of the sender
`message.sender.id`	Text	Unique identifier of the sender
`message.sender.type`	Text	Type of the sender (e.g., enduser)
`message.sender.picture`	Text	URL to the sender's profile picture
`message.created`	Text	Timestamp when the message was created
`message.isFirstMessage`	Yes / No	Whether this is the first message in the conversation
`enduser`	Any
`enduser.id`	Text	Unique identifier for the enduser
`enduser.recurrent`	Yes / No	Whether the enduser is recurrent
`team`	Any
`team.id`	Text	Unique identifier for the team
`assignee`	Any
`assignee.id`	Text	Unique identifier for the assignee

Conversation Closed

Triggered when a conversation is closed

Settings

No settings.

Output

Later steps use this data through Current Trigger in the $ picker. For example, conversation.id is $trigger.output.conversation.id.

json

{
  "conversation": {
    "id": "string",
    "orgId": "string",
    "name": "string",
    "memos": [
      {
        "id": "string",
        "text": "string",
        "created": "string",
        "sender": {}
      }
    ],
    "tags": [
      "string"
    ],
    "status": "string",
    "statusUpdatedAt": "string",
    "created": "string",
    "isAssigned": false,
    "ocsChannel": "string",
    "platform": {},
    "teamId": "string",
    "autoClosedConversation": false
  },
  "message": "string",
  "enduser": {
    "id": "string",
    "recurrent": false
  },
  "team": {
    "id": "string"
  },
  "assignee": {
    "id": "string"
  }
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`conversation`	Any
`conversation.id`	Text	Unique identifier for the conversation
`conversation.orgId`	Text	ID of the organization
`conversation.name`	Text	Name of the conversation
`conversation.memos[]`	List	Array of memos
`conversation.memos[].id`	Text	Unique identifier for the memo
`conversation.memos[].text`	Text	Text of the memo
`conversation.memos[].created`	Text	Timestamp when the memo was created
`conversation.memos[].sender`	Any
`conversation.memos[].sender.id`	Text	Unique identifier for the sender
`conversation.memos[].sender.name`	Text	Name of the sender
`conversation.memos[].sender.email`	Text	Email of the sender
`conversation.tags[]`	List	Array of tags
`conversation.status`	Text	Status of the conversation
`conversation.statusUpdatedAt`	Text	Timestamp when the status was updated
`conversation.created`	Text	Timestamp when the conversation was created
`conversation.isAssigned`	Yes / No	Whether the conversation is assigned
`conversation.ocsChannel`	Text	OCS channel of the conversation
`conversation.platform`	Any
`conversation.platform.name`	Text	Name of the platform
`conversation.platform.channelId`	Text	ID of the channel
`conversation.platform.channelName`	Text	Name of the channel
`conversation.teamId`	Text	ID of the team
`conversation.autoClosedConversation`	Yes / No	Whether the conversation is auto closed
`message`	Any
`message.id`	Text	Unique identifier for the message
`message.from`	Text	Source of the message (e.g., user, bot)
`message.conversationId`	Text	ID of the conversation this message belongs to
`message.type`	Text	Type of the message (e.g., text)
`message.data`	Object	Message data content
`message.data.metadata`	Object	Additional metadata about the message
`message.data.metadata.sender`	Object	Information about the message sender
`message.data.id`	Text	Unique identifier for the message data
`message.data.text`	Text	Text content of the message
`message.data.type`	Text	Type of the message data
`message.sender`	Object	Information about the message sender
`message.sender.name`	Text	Name of the sender
`message.sender.id`	Text	Unique identifier of the sender
`message.sender.type`	Text	Type of the sender (e.g., enduser)
`message.sender.picture`	Text	URL to the sender's profile picture
`message.created`	Text	Timestamp when the message was created
`message.isFirstMessage`	Yes / No	Whether this is the first message in the conversation
`enduser`	Any
`enduser.id`	Text	Unique identifier for the enduser
`enduser.recurrent`	Yes / No	Whether the enduser is recurrent
`team`	Any
`team.id`	Text	Unique identifier for the team
`assignee`	Any
`assignee.id`	Text	Unique identifier for the assignee

Message Received

Triggered when a conversation is received a new message

Settings

No settings.

Output

Later steps use this data through Current Trigger in the $ picker. For example, conversation.id is $trigger.output.conversation.id.

json

{
  "conversation": {
    "id": "string",
    "orgId": "string",
    "name": "string",
    "memos": [
      {
        "id": "string",
        "text": "string",
        "created": "string",
        "sender": {}
      }
    ],
    "tags": [
      "string"
    ],
    "status": "string",
    "statusUpdatedAt": "string",
    "created": "string",
    "isAssigned": false,
    "ocsChannel": "string",
    "platform": {},
    "teamId": "string",
    "autoClosedConversation": false
  },
  "message": "string",
  "enduser": {
    "id": "string",
    "recurrent": false
  },
  "team": {
    "id": "string"
  },
  "assignee": {
    "id": "string"
  }
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`conversation`	Any
`conversation.id`	Text	Unique identifier for the conversation
`conversation.orgId`	Text	ID of the organization
`conversation.name`	Text	Name of the conversation
`conversation.memos[]`	List	Array of memos
`conversation.memos[].id`	Text	Unique identifier for the memo
`conversation.memos[].text`	Text	Text of the memo
`conversation.memos[].created`	Text	Timestamp when the memo was created
`conversation.memos[].sender`	Any
`conversation.memos[].sender.id`	Text	Unique identifier for the sender
`conversation.memos[].sender.name`	Text	Name of the sender
`conversation.memos[].sender.email`	Text	Email of the sender
`conversation.tags[]`	List	Array of tags
`conversation.status`	Text	Status of the conversation
`conversation.statusUpdatedAt`	Text	Timestamp when the status was updated
`conversation.created`	Text	Timestamp when the conversation was created
`conversation.isAssigned`	Yes / No	Whether the conversation is assigned
`conversation.ocsChannel`	Text	OCS channel of the conversation
`conversation.platform`	Any
`conversation.platform.name`	Text	Name of the platform
`conversation.platform.channelId`	Text	ID of the channel
`conversation.platform.channelName`	Text	Name of the channel
`conversation.teamId`	Text	ID of the team
`conversation.autoClosedConversation`	Yes / No	Whether the conversation is auto closed
`message`	Any
`message.id`	Text	Unique identifier for the message
`message.from`	Text	Source of the message (e.g., user, bot)
`message.conversationId`	Text	ID of the conversation this message belongs to
`message.type`	Text	Type of the message (e.g., text)
`message.data`	Object	Message data content
`message.data.metadata`	Object	Additional metadata about the message
`message.data.metadata.sender`	Object	Information about the message sender
`message.data.id`	Text	Unique identifier for the message data
`message.data.text`	Text	Text content of the message
`message.data.type`	Text	Type of the message data
`message.sender`	Object	Information about the message sender
`message.sender.name`	Text	Name of the sender
`message.sender.id`	Text	Unique identifier of the sender
`message.sender.type`	Text	Type of the sender (e.g., enduser)
`message.sender.picture`	Text	URL to the sender's profile picture
`message.created`	Text	Timestamp when the message was created
`message.isFirstMessage`	Yes / No	Whether this is the first message in the conversation
`enduser`	Any
`enduser.id`	Text	Unique identifier for the enduser
`enduser.recurrent`	Yes / No	Whether the enduser is recurrent
`team`	Any
`team.id`	Text	Unique identifier for the team
`assignee`	Any
`assignee.id`	Text	Unique identifier for the assignee

Conversation Assignee Updated

Triggered when an assignee of a conversation is updated

Settings

No settings.

Output

Later steps use this data through Current Trigger in the $ picker. For example, conversation.id is $trigger.output.conversation.id.

json

{
  "conversation": {
    "id": "string",
    "orgId": "string",
    "name": "string",
    "memos": [
      {
        "id": "string",
        "text": "string",
        "created": "string",
        "sender": {}
      }
    ],
    "tags": [
      "string"
    ],
    "status": "string",
    "statusUpdatedAt": "string",
    "created": "string",
    "isAssigned": false,
    "ocsChannel": "string",
    "platform": {},
    "teamId": "string",
    "autoClosedConversation": false
  },
  "message": "string",
  "enduser": {
    "id": "string",
    "recurrent": false
  },
  "team": {
    "id": "string"
  },
  "assignee": {
    "id": "string"
  }
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`conversation`	Any
`conversation.id`	Text	Unique identifier for the conversation
`conversation.orgId`	Text	ID of the organization
`conversation.name`	Text	Name of the conversation
`conversation.memos[]`	List	Array of memos
`conversation.memos[].id`	Text	Unique identifier for the memo
`conversation.memos[].text`	Text	Text of the memo
`conversation.memos[].created`	Text	Timestamp when the memo was created
`conversation.memos[].sender`	Any
`conversation.memos[].sender.id`	Text	Unique identifier for the sender
`conversation.memos[].sender.name`	Text	Name of the sender
`conversation.memos[].sender.email`	Text	Email of the sender
`conversation.tags[]`	List	Array of tags
`conversation.status`	Text	Status of the conversation
`conversation.statusUpdatedAt`	Text	Timestamp when the status was updated
`conversation.created`	Text	Timestamp when the conversation was created
`conversation.isAssigned`	Yes / No	Whether the conversation is assigned
`conversation.ocsChannel`	Text	OCS channel of the conversation
`conversation.platform`	Any
`conversation.platform.name`	Text	Name of the platform
`conversation.platform.channelId`	Text	ID of the channel
`conversation.platform.channelName`	Text	Name of the channel
`conversation.teamId`	Text	ID of the team
`conversation.autoClosedConversation`	Yes / No	Whether the conversation is auto closed
`message`	Any
`message.id`	Text	Unique identifier for the message
`message.from`	Text	Source of the message (e.g., user, bot)
`message.conversationId`	Text	ID of the conversation this message belongs to
`message.type`	Text	Type of the message (e.g., text)
`message.data`	Object	Message data content
`message.data.metadata`	Object	Additional metadata about the message
`message.data.metadata.sender`	Object	Information about the message sender
`message.data.id`	Text	Unique identifier for the message data
`message.data.text`	Text	Text content of the message
`message.data.type`	Text	Type of the message data
`message.sender`	Object	Information about the message sender
`message.sender.name`	Text	Name of the sender
`message.sender.id`	Text	Unique identifier of the sender
`message.sender.type`	Text	Type of the sender (e.g., enduser)
`message.sender.picture`	Text	URL to the sender's profile picture
`message.created`	Text	Timestamp when the message was created
`message.isFirstMessage`	Yes / No	Whether this is the first message in the conversation
`enduser`	Any
`enduser.id`	Text	Unique identifier for the enduser
`enduser.recurrent`	Yes / No	Whether the enduser is recurrent
`team`	Any
`team.id`	Text	Unique identifier for the team
`assignee`	Any
`assignee.id`	Text	Unique identifier for the assignee

Actions

Steps this node can perform. Add one from Add a step, then pick the action.

List Conversations

Get a list of all conversations

Settings

Field	Type	Required	Description
Status	Choice	Yes	Status of the conversations Options: `New`, `In Progress`, `Wrap Up`, `Completed`
Team ID	Text		Team ID of the conversations
Assigned	Yes / No		Whether the conversations are assigned
Per Page	Number	Yes	Number of items to get per page Default: `20`
Next	Text		Next cursor to get the next page of items

Output

Later steps use this data by picking this step in the $ picker. For example, data[0].id is $.<step ID>.output.data[0].id.

json

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "status": "new",
      "teamId": "string",
      "enduser": {
        "id": "string",
        "name": "string",
        "platform": "line",
        "picture": "string"
      },
      "enduserId": "string",
      "assigneeId": "string",
      "ocsChannel": "string",
      "integrationId": "string",
      "unread": false,
      "orgId": "string",
      "created": "string",
      "platform": {},
      "fromChatbot": false,
      "isNewConversation": false,
      "team": {
        "id": "string",
        "name": "string"
      },
      "assignee": {
        "id": "string",
        "name": "string"
      },
      "isBookmark": false
    }
  ],
  "pagination": {
    "perPage": 0,
    "next": "string"
  }
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`data[]`	List	Array of items
`data[].id`	Text	Unique identifier for the conversation
`data[].name`	Text	Name of the conversation
`data[].status`	Text	Current status of the conversation (e.g., new)
`data[].teamId`	Text	ID of the team handling the conversation
`data[].enduser`	Object	Information about the end user
`data[].enduser.id`	Text	Unique identifier of the end user
`data[].enduser.name`	Text	Name of the end user
`data[].enduser.platform`	Text	Platform the end user is using (e.g., line)
`data[].enduser.picture`	Text	URL to the end user's profile picture
`data[].enduserId`	Text	ID of the end user
`data[].assigneeId`	Text	ID of the team member assigned to the conversation
`data[].ocsChannel`	Text	Channel identifier for OCS
`data[].integrationId`	Text	ID of the integration being used
`data[].unread`	Yes / No	Whether the conversation has unread messages
`data[].orgId`	Text	ID of the organization
`data[].created`	Text	Timestamp when the conversation was created
`data[].platform`	Any
`data[].platform.name`	Text	Name of the platform
`data[].platform.channelId`	Text	ID of the channel
`data[].platform.channelName`	Text	Name of the channel
`data[].fromChatbot`	Yes / No	Whether the conversation was initiated by a chatbot
`data[].isNewConversation`	Yes / No	Whether this is a new conversation
`data[].team`	Object	Information about the team
`data[].team.id`	Text	ID of the team
`data[].team.name`	Text	Name of the team
`data[].assignee`	Object	Information about the assignee
`data[].assignee.id`	Text	ID of the assignee
`data[].assignee.name`	Text	Name of the assignee
`data[].isBookmark`	Yes / No	Whether the conversation is bookmarked
`pagination`	Object	Pagination information
`pagination.perPage`	Number	Number of items to get per page
`pagination.next`	Text	Next cursor to get the next page of items

Update Conversation Status

Update the status of a conversation

Settings

Field	Type	Required	Description
Conversation ID	Text	Yes	ID of the conversation to update
Status	Choice	Yes	Status of the conversation Options: `Wrap Up`, `Completed`

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

json

{
  "id": "string",
  "name": "string",
  "status": "new",
  "teamId": "string",
  "enduser": {
    "id": "string",
    "name": "string",
    "platform": "line",
    "picture": "string"
  },
  "enduserId": "string",
  "assigneeId": "string",
  "ocsChannel": "string",
  "integrationId": "string",
  "unread": false,
  "orgId": "string",
  "created": "string",
  "platform": {},
  "fromChatbot": false,
  "isNewConversation": false,
  "team": {
    "id": "string",
    "name": "string"
  },
  "assignee": {
    "id": "string",
    "name": "string"
  },
  "isBookmark": false
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`id`	Text	Unique identifier for the conversation
`name`	Text	Name of the conversation
`status`	Text	Current status of the conversation (e.g., new)
`teamId`	Text	ID of the team handling the conversation
`enduser`	Object	Information about the end user
`enduser.id`	Text	Unique identifier of the end user
`enduser.name`	Text	Name of the end user
`enduser.platform`	Text	Platform the end user is using (e.g., line)
`enduser.picture`	Text	URL to the end user's profile picture
`enduserId`	Text	ID of the end user
`assigneeId`	Text	ID of the team member assigned to the conversation
`ocsChannel`	Text	Channel identifier for OCS
`integrationId`	Text	ID of the integration being used
`unread`	Yes / No	Whether the conversation has unread messages
`orgId`	Text	ID of the organization
`created`	Text	Timestamp when the conversation was created
`platform`	Any
`platform.name`	Text	Name of the platform
`platform.channelId`	Text	ID of the channel
`platform.channelName`	Text	Name of the channel
`fromChatbot`	Yes / No	Whether the conversation was initiated by a chatbot
`isNewConversation`	Yes / No	Whether this is a new conversation
`team`	Object	Information about the team
`team.id`	Text	ID of the team
`team.name`	Text	Name of the team
`assignee`	Object	Information about the assignee
`assignee.id`	Text	ID of the assignee
`assignee.name`	Text	Name of the assignee
`isBookmark`	Yes / No	Whether the conversation is bookmarked

Add Conversation Memo

Add a memo to a conversation

Settings

Field	Type	Required	Description
Conversation ID	Text	Yes	ID of the conversation to add memo
Memo	Text	Yes	Memo of the conversation

Output

Later steps use this data by picking this step in the $ picker. For example, status is $.<step ID>.output.status.

json

{
  "status": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`status`	Text	"success" when the DECA Livechat API accepted the update

Update Conversation Memo

Update the memo of a conversation

Settings

Field	Type	Required	Description
Conversation ID	Text	Yes	ID of the conversation to update
Memo ID	Text	Yes	ID of the memo to update
Memo	Text	Yes	Memo of the conversation

Output

Later steps use this data by picking this step in the $ picker. For example, status is $.<step ID>.output.status.

json

{
  "status": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`status`	Text	"success" when the DECA Livechat API accepted the update

Get Conversation Messages

Get all messages in a conversation

Settings

Field	Type	Required	Description
Conversation ID	Text	Yes	ID of the conversation to get messages from
Include Activities	Yes / No		Whether to include activities messages in the response
Per Page	Number	Yes	Number of items to get per page Default: `20`
Next	Text		Next cursor to get the next page of items

Output

Later steps use this data by picking this step in the $ picker. For example, data[0].id is $.<step ID>.output.data[0].id.

json

{
  "data": [
    {
      "id": "string",
      "from": "user",
      "conversationId": "string",
      "type": "text",
      "data": {
        "metadata": {},
        "id": "string",
        "text": "string",
        "type": "string"
      },
      "sender": {
        "name": "string",
        "id": "string",
        "type": "enduser",
        "picture": "string"
      },
      "created": "string",
      "isFirstMessage": false
    }
  ],
  "pagination": {
    "perPage": 0,
    "next": "string"
  }
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`data[]`	List	Array of items
`data[].id`	Text	Unique identifier for the message
`data[].from`	Text	Source of the message (e.g., user, bot)
`data[].conversationId`	Text	ID of the conversation this message belongs to
`data[].type`	Text	Type of the message (e.g., text)
`data[].data`	Object	Message data content
`data[].data.metadata`	Object	Additional metadata about the message
`data[].data.metadata.sender`	Object	Information about the message sender
`data[].data.id`	Text	Unique identifier for the message data
`data[].data.text`	Text	Text content of the message
`data[].data.type`	Text	Type of the message data
`data[].sender`	Object	Information about the message sender
`data[].sender.name`	Text	Name of the sender
`data[].sender.id`	Text	Unique identifier of the sender
`data[].sender.type`	Text	Type of the sender (e.g., enduser)
`data[].sender.picture`	Text	URL to the sender's profile picture
`data[].created`	Text	Timestamp when the message was created
`data[].isFirstMessage`	Yes / No	Whether this is the first message in the conversation
`pagination`	Object	Pagination information
`pagination.perPage`	Number	Number of items to get per page
`pagination.next`	Text	Next cursor to get the next page of items

Send Text Message

Send a text message to a conversation

Settings

Field	Type	Required	Description
Conversation ID	Text	Yes	ID of the conversation to send message to
Message	Text	Yes	Text message to send

Output

No documented output fields.

Send Message with an Image

Send a message with an image to a conversation

Settings

Field	Type	Required	Description
Conversation ID	Text	Yes	ID of the conversation to send message to
Image Source	Choice	Yes	Where the image comes from Options: `URL`, `File` Default: `url`
Image File	File	Yes	Image file to send (PNG or JPEG)
Image URL	Text		URL of the original image

Output

No documented output fields.

Get Conversation Detail

Get details about a conversation

Settings

Field	Type	Required	Description
Conversation ID	Text	Yes	ID of the conversation to get detail from

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

json

{
  "id": "string",
  "name": "string",
  "status": "new",
  "teamId": "string",
  "enduser": {
    "id": "string",
    "name": "string",
    "platform": "line",
    "picture": "string"
  },
  "enduserId": "string",
  "assigneeId": "string",
  "ocsChannel": "string",
  "integrationId": "string",
  "unread": false,
  "orgId": "string",
  "created": "string",
  "platform": {},
  "fromChatbot": false,
  "isNewConversation": false,
  "team": {
    "id": "string",
    "name": "string"
  },
  "assignee": {
    "id": "string",
    "name": "string"
  },
  "isBookmark": false
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`id`	Text	Unique identifier for the conversation
`name`	Text	Name of the conversation
`status`	Text	Current status of the conversation (e.g., new)
`teamId`	Text	ID of the team handling the conversation
`enduser`	Object	Information about the end user
`enduser.id`	Text	Unique identifier of the end user
`enduser.name`	Text	Name of the end user
`enduser.platform`	Text	Platform the end user is using (e.g., line)
`enduser.picture`	Text	URL to the end user's profile picture
`enduserId`	Text	ID of the end user
`assigneeId`	Text	ID of the team member assigned to the conversation
`ocsChannel`	Text	Channel identifier for OCS
`integrationId`	Text	ID of the integration being used
`unread`	Yes / No	Whether the conversation has unread messages
`orgId`	Text	ID of the organization
`created`	Text	Timestamp when the conversation was created
`platform`	Any
`platform.name`	Text	Name of the platform
`platform.channelId`	Text	ID of the channel
`platform.channelName`	Text	Name of the channel
`fromChatbot`	Yes / No	Whether the conversation was initiated by a chatbot
`isNewConversation`	Yes / No	Whether this is a new conversation
`team`	Object	Information about the team
`team.id`	Text	ID of the team
`team.name`	Text	Name of the team
`assignee`	Object	Information about the assignee
`assignee.id`	Text	ID of the assignee
`assignee.name`	Text	Name of the assignee
`isBookmark`	Yes / No	Whether the conversation is bookmarked

Assign to Team

Assign a conversation to a team using an assignment rule.

Settings

Field	Type	Required	Description
Conversation ID	Text	Yes	ID of the conversation to assign
Team	Choice (loaded from your account)	Yes	Team to assign the conversation to
Assignment Methods	Choice	Yes	How to pick an operator in the selected team Options: `Round Robin`, `Random`, `Least Active Conversations`, `Longest Idle Time`, `Unspecified` Default: `no_specified`
Number of inquiries per agent	Yes / No		Limit number of correspondence Default: `false`
Limit to	Number		Maximum open conversations per agent Default: `1`
Prioritize Assigning Pending Conversations	Yes / No		When a new conversation is created, prioritize assigning unassigned pending conversations first. Default: `false`

Output

Later steps use this data by picking this step in the $ picker. For example, status is $.<step ID>.output.status.

json

{
  "status": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`status`	Text	Handler completion status. success means the handler finished, not that assignment succeeded.

Assign to Assignee

Assign a conversation to a specific operator in a selected team.

Settings

Field	Type	Required	Description
Conversation ID	Text	Yes	ID of the conversation to assign
Team	Choice (loaded from your account)	Yes	Team used to list operators
Assignee	Choice (loaded from your account)	Yes	Operator to assign the conversation to

Output

Later steps use this data by picking this step in the $ picker. For example, status is $.<step ID>.output.status.

json

{
  "status": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`status`	Text	Handler completion status. success means the handler finished, not that assignment succeeded.

Reassign to the previous Person in charge

Reassign a conversation to the previous person in charge.

Settings

Field	Type	Required	Description
Conversation ID	Text	Yes	ID of the conversation to assign

Output

Later steps use this data by picking this step in the $ picker. For example, status is $.<step ID>.output.status.

json

{
  "status": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`status`	Text	Handler completion status. success means the handler finished, not that assignment succeeded.

Send to Webhook

Send a conversation to a webhook integration selected from a dynamic list.

Settings

Field	Type	Required	Description
Conversation ID	Text	Yes	ID of the conversation to send
Webhook Integration	Choice (loaded from your account)	Yes	Webhook integration to send the conversation to

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

json

{
  "id": "string",
  "name": "string",
  "status": "new",
  "teamId": "string",
  "enduser": {
    "id": "string",
    "name": "string",
    "platform": "line",
    "picture": "string"
  },
  "enduserId": "string",
  "assigneeId": "string",
  "ocsChannel": "string",
  "integrationId": "string",
  "unread": false,
  "orgId": "string",
  "created": "string",
  "platform": {},
  "fromChatbot": false,
  "isNewConversation": false,
  "team": {
    "id": "string",
    "name": "string"
  },
  "assignee": {
    "id": "string",
    "name": "string"
  },
  "isBookmark": false
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`id`	Text	Unique identifier for the conversation
`name`	Text	Name of the conversation
`status`	Text	Current status of the conversation (e.g., new)
`teamId`	Text	ID of the team handling the conversation
`enduser`	Object	Information about the end user
`enduser.id`	Text	Unique identifier of the end user
`enduser.name`	Text	Name of the end user
`enduser.platform`	Text	Platform the end user is using (e.g., line)
`enduser.picture`	Text	URL to the end user's profile picture
`enduserId`	Text	ID of the end user
`assigneeId`	Text	ID of the team member assigned to the conversation
`ocsChannel`	Text	Channel identifier for OCS
`integrationId`	Text	ID of the integration being used
`unread`	Yes / No	Whether the conversation has unread messages
`orgId`	Text	ID of the organization
`created`	Text	Timestamp when the conversation was created
`platform`	Any
`platform.name`	Text	Name of the platform
`platform.channelId`	Text	ID of the channel
`platform.channelName`	Text	Name of the channel
`fromChatbot`	Yes / No	Whether the conversation was initiated by a chatbot
`isNewConversation`	Yes / No	Whether this is a new conversation
`team`	Object	Information about the team
`team.id`	Text	ID of the team
`team.name`	Text	Name of the team
`assignee`	Object	Information about the assignee
`assignee.id`	Text	ID of the assignee
`assignee.name`	Text	Name of the assignee
`isBookmark`	Yes / No	Whether the conversation is bookmarked

LiveChat ​

Triggers ​

Conversation Created ​

Conversation Closed ​

Message Received ​

Conversation Assignee Updated ​

Actions ​

List Conversations ​

Update Conversation Status ​

Add Conversation Memo ​

Update Conversation Memo ​

Get Conversation Messages ​

Send Text Message ​

Send Message with an Image ​

Get Conversation Detail ​

Assign to Team ​

Assign to Assignee ​

Reassign to the previous Person in charge ​

Send to Webhook ​

LiveChat

Triggers

Conversation Created

Conversation Closed

Message Received

Conversation Assignee Updated

Actions

List Conversations

Update Conversation Status

Add Conversation Memo

Update Conversation Memo

Get Conversation Messages

Send Text Message

Send Message with an Image

Get Conversation Detail

Assign to Team

Assign to Assignee

Reassign to the previous Person in charge

Send to Webhook