Chatbot

Interact with Chatbot

Triggers

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

Message Sent

Triggered when a response is sent from the chatbot to a user

Settings

No settings.

Output

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

{
  "channelId": "string",
  "traits": {
    "organizationId": "string",
    "botId": "string",
    "integrationId": "string"
  },
  "content": {
    "userId": "string",
    "messages": [
      {}
    ],
    "replyToken": "string",
    "channels": [
      "string"
    ],
    "data": {
      "messages": [
        {}
      ]
    }
  }
}

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

Field descriptions

Field	Type	Description
channelId	Text	ID of the channel
traits	Object	Traits of the event
traits.organizationId	Text	ID of the organization
traits.botId	Text	ID of the bot
traits.integrationId	Text	ID of the integration
content	Object	Content of the sent message
content.userId	Text	ID of the user (Use in message sent to LINE)
content.messages[]	List	Messages of the event (Use in message sent to LINE)
content.replyToken	Text	Reply token of the event (Use in message sent to LINE)
content.channels[]	List	Websocket channels (Use in message sent to WEB)
content.data	Object	Data of the sent message (Use in message sent to WEB)
content.data.messages[]	List	Messages of the event (Use in message sent to WEB)
content.data.messages[].type	Text	Type of the message
content.data.messages[].from	Text	The message sent from
content.data.messages[].data	Object	Data of the message (The structure is different depending on the type of message)

Message Received

Triggered when a new message is received from a user to the chatbot

Settings

No settings.

Output

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

{
  "botId": "string",
  "integrationId": "string",
  "organizationId": "string",
  "userId": "string",
  "platform": {},
  "data": {
    "events": [
      {
        "type": "string",
        "source": {},
        "message": {},
        "variables": "string"
      }
    ]
  }
}

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

Field descriptions

Field	Type	Description
botId	Text	ID of the bot
integrationId	Text	ID of the integration
organizationId	Text	ID of the organization
userId	Text	ID of the user
platform	Object	Platform converastion (line, web)
data	Object	Data of the received message
data.events[]	List	Events of the conversation
data.events[].type	Text	Type of the event
data.events[].source	Object	Source of the event
data.events[].source.type	Text	Type of the source
data.events[].source.userId	Text	ID of the user
data.events[].message	Object	Message data
data.events[].message.type	Text	Type of the message
data.events[].message.data	Object	Data of the message
data.events[].variables	Key–value pairs	Variables

Actions

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

Create Bot

Create a new chatbot

Settings

Field	Type	Required	Description
Name	Text	Yes	Name of the bot
Description	Text		Description of the bot
Connect Bot	Yes / No		Choose whether the bot should be connected

Output

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

{
  "id": "string",
  "name": "string",
  "avatar": "string",
  "organizationId": "string",
  "status": "string",
  "description": "string",
  "diagramVersion": 0,
  "isConnected": false,
  "metadata": "string",
  "settings": {
    "intentGlobalNoMatch": "string",
    "timeoutFlowEnabled": false,
    "endConversationMessage": {
      "enable": false,
      "message": "string"
    }
  },
  "created": "string",
  "updated": "string"
}

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 bot
name	Text	Name of the bot
avatar	Text	Avatar URL for the bot
organizationId	Text	ID of the organization that owns the bot
status	Text	Current status of the bot (DRAFT, PUBLISHED, UNPUBLISHED)
description	Text	Description of the bot
diagramVersion	Number	Version number of the bot's diagram
isConnected	Yes / No	Whether the bot is currently connected
metadata	Key–value pairs	Additional metadata for the bot
settings	Object	Configuration settings for the bot
settings.intentGlobalNoMatch	Text	Global no match intent setting
settings.timeoutFlowEnabled	Yes / No	Whether timeout flow is enabled
settings.endConversationMessage	Object	End conversation message settings
settings.endConversationMessage.enable	Yes / No	Whether to enable end conversation message
settings.endConversationMessage.message	Text	End conversation message text
created	Text	Timestamp when the bot was created
updated	Text	Timestamp when the bot was last updated

Get Bots

Get all chatbots

Settings

Field	Type	Required	Description
Limit	Number	Yes	Limit the number of bots to get Default: 20
Next	Text		Next cursor to get the next page of bots

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.

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "avatar": "string",
      "organizationId": "string",
      "status": "string",
      "description": "string",
      "diagramVersion": 0,
      "isConnected": false,
      "metadata": "string",
      "settings": {
        "intentGlobalNoMatch": "string",
        "timeoutFlowEnabled": false,
        "endConversationMessage": {}
      },
      "created": "string",
      "updated": "string"
    }
  ],
  "pagination": {
    "limit": 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	Data of the items
data[].id	Text	Unique identifier for the bot
data[].name	Text	Name of the bot
data[].avatar	Text	Avatar URL for the bot
data[].organizationId	Text	ID of the organization that owns the bot
data[].status	Text	Current status of the bot (DRAFT, PUBLISHED, UNPUBLISHED)
data[].description	Text	Description of the bot
data[].diagramVersion	Number	Version number of the bot's diagram
data[].isConnected	Yes / No	Whether the bot is currently connected
data[].metadata	Key–value pairs	Additional metadata for the bot
data[].settings	Object	Configuration settings for the bot
data[].settings.intentGlobalNoMatch	Text	Global no match intent setting
data[].settings.timeoutFlowEnabled	Yes / No	Whether timeout flow is enabled
data[].settings.endConversationMessage	Object	End conversation message settings
data[].settings.endConversationMessage.enable	Yes / No	Whether to enable end conversation message
data[].settings.endConversationMessage.message	Text	End conversation message text
data[].created	Text	Timestamp when the bot was created
data[].updated	Text	Timestamp when the bot was last updated
pagination	Object	Pagination information
pagination.limit	Number	Number of items to get per page
pagination.next	Text	Next cursor to get the next page of items

Update Bot

Update an existing chatbot

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to update
Name	Text		Name of the bot
Description	Text		Description of the bot
Status	Choice		Options: Draft, Published, Unpublished
Connect Bot	Yes / No		Whether the bot should be connected

Output

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

{
  "id": "string",
  "name": "string",
  "avatar": "string",
  "organizationId": "string",
  "status": "string",
  "description": "string",
  "diagramVersion": 0,
  "isConnected": false,
  "metadata": "string",
  "settings": {
    "intentGlobalNoMatch": "string",
    "timeoutFlowEnabled": false,
    "endConversationMessage": {
      "enable": false,
      "message": "string"
    }
  },
  "created": "string",
  "updated": "string"
}

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 bot
name	Text	Name of the bot
avatar	Text	Avatar URL for the bot
organizationId	Text	ID of the organization that owns the bot
status	Text	Current status of the bot (DRAFT, PUBLISHED, UNPUBLISHED)
description	Text	Description of the bot
diagramVersion	Number	Version number of the bot's diagram
isConnected	Yes / No	Whether the bot is currently connected
metadata	Key–value pairs	Additional metadata for the bot
settings	Object	Configuration settings for the bot
settings.intentGlobalNoMatch	Text	Global no match intent setting
settings.timeoutFlowEnabled	Yes / No	Whether timeout flow is enabled
settings.endConversationMessage	Object	End conversation message settings
settings.endConversationMessage.enable	Yes / No	Whether to enable end conversation message
settings.endConversationMessage.message	Text	End conversation message text
created	Text	Timestamp when the bot was created
updated	Text	Timestamp when the bot was last updated

Get Bot

Get an existing chatbot

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to get

Output

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

{
  "id": "string",
  "name": "string",
  "avatar": "string",
  "organizationId": "string",
  "status": "string",
  "description": "string",
  "diagramVersion": 0,
  "isConnected": false,
  "metadata": "string",
  "settings": {
    "intentGlobalNoMatch": "string",
    "timeoutFlowEnabled": false,
    "endConversationMessage": {
      "enable": false,
      "message": "string"
    }
  },
  "created": "string",
  "updated": "string"
}

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 bot
name	Text	Name of the bot
avatar	Text	Avatar URL for the bot
organizationId	Text	ID of the organization that owns the bot
status	Text	Current status of the bot (DRAFT, PUBLISHED, UNPUBLISHED)
description	Text	Description of the bot
diagramVersion	Number	Version number of the bot's diagram
isConnected	Yes / No	Whether the bot is currently connected
metadata	Key–value pairs	Additional metadata for the bot
settings	Object	Configuration settings for the bot
settings.intentGlobalNoMatch	Text	Global no match intent setting
settings.timeoutFlowEnabled	Yes / No	Whether timeout flow is enabled
settings.endConversationMessage	Object	End conversation message settings
settings.endConversationMessage.enable	Yes / No	Whether to enable end conversation message
settings.endConversationMessage.message	Text	End conversation message text
created	Text	Timestamp when the bot was created
updated	Text	Timestamp when the bot was last updated

Delete Bot

Delete an existing chatbot

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to delete

Output

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

{
  "data": "string",
  "status": "string"
}

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

Field descriptions

Field	Type	Description
data	Any	Result returned by the DECA Chatbot API. Its shape depends on the action: a delete may return the removed record, true, an empty object, or nothing
status	Text	"success" when the DECA Chatbot API accepted the request

Get Diagram

Get the diagram for a chatbot

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to get the diagram for

Output

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

{
  "flows": [
    {
      "id": "string",
      "botId": "string",
      "name": "string",
      "category": "string",
      "type": "string",
      "nodes": {},
      "configs": {
        "intentNodes": []
      },
      "created": "string",
      "updated": "string"
    }
  ],
  "version": 0,
  "variables": [
    {
      "botId": "string",
      "id": "string",
      "name": "string",
      "created": "string",
      "updated": "string"
    }
  ],
  "intents": [
    {
      "id": "string",
      "label": "string",
      "language": "string",
      "botId": "string",
      "utterances": [
        "string"
      ],
      "created": "string",
      "updated": "string"
    }
  ],
  "settings": {}
}

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

Field descriptions

Field	Type	Description
flows[]	List	Flows in the diagram
flows[].id	Text	ID of the flow
flows[].botId	Text	ID of the bot this flow belongs to
flows[].name	Text	Name of the flow
flows[].category	Text	Category of the flow
flows[].type	Text	Type of the flow
flows[].nodes	Object	Nodes in the flow
flows[].configs	Object	Configuration for the flow
flows[].configs.intentNodes[]	List	Intent nodes configuration
flows[].configs.intentNodes[].intentScope	Text	Scope of the intent
flows[].configs.intentNodes[].intentId	Text	ID of the intent
flows[].configs.intentNodes[].ID	Text	ID of the flow
flows[].created	Text	Timestamp when the flow was created
flows[].updated	Text	Timestamp when the flow was last updated
version	Number	Version number of the diagram
variables[]	List	Variables in the diagram
variables[].botId	Text	ID of the bot this variable belongs to
variables[].id	Text	ID of the variable
variables[].name	Text	Name of the variable
variables[].created	Text	Timestamp when the variable was created
variables[].updated	Text	Timestamp when the variable was last updated
intents[]	List	Intents in the diagram
intents[].id	Text	ID of the intent
intents[].label	Text	Label of the intent
intents[].language	Text	Language of the intent
intents[].botId	Text	ID of the bot this intent belongs to
intents[].utterances[]	List	List of utterances for the intent
intents[].created	Text	Timestamp when the intent was created
intents[].updated	Text	Timestamp when the intent was last updated
settings	Object	Settings for the diagram

Get Diagram Versions

Get all versions of the diagram for a chatbot

Settings

Field	Type	Required	Description
Bot ID	Text	Yes
Type	Choice		Options: User-created, Auto-generated
Limitation	Number	Yes	Select or enter the maximum number of versions to retrieve. Default: 20
Next Cursor	Text		ID of the bot whose diagram versions to retrieve

Output

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

{
  "data": [
    {
      "name": "string",
      "botId": "string",
      "created": "string",
      "updated": "string",
      "version": 0,
      "type": "string"
    }
  ],
  "pagination": {
    "limit": 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	Data of the items
data[].name	Text	Name of the diagram version
data[].botId	Text	ID of the bot this diagram version belongs to
data[].created	Text	Timestamp when the diagram version was created
data[].updated	Text	Timestamp when the diagram version was last updated
data[].version	Number	Version number of the diagram
data[].type	Text	Type of the diagram version
pagination	Object	Pagination information
pagination.limit	Number	Number of items to get per page
pagination.next	Text	Next cursor to get the next page of items

Create Diagram Version

Create a new version of the diagram

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to create the diagram version for
Name	Text		Name of the diagram version

Output

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

{
  "data": "string",
  "status": "string"
}

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

Field descriptions

Field	Type	Description
data	Any
data.name	Text	Name of the diagram version
data.botId	Text	ID of the bot this diagram version belongs to
data.created	Text	Timestamp when the diagram version was created
data.updated	Text	Timestamp when the diagram version was last updated
data.version	Number	Version number of the diagram
data.type	Text	Type of the diagram version
status	Text	"success" when the DECA Chatbot API accepted the request

Get Diagram Version

Get a version of the diagram

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to get the diagram version for
Version	Number	Yes	Version number of the diagram to get

Output

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

{
  "name": "string",
  "botId": "string",
  "created": "string",
  "updated": "string",
  "version": 0,
  "type": "string"
}

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

Field descriptions

Field	Type	Description
name	Text	Name of the diagram version
botId	Text	ID of the bot this diagram version belongs to
created	Text	Timestamp when the diagram version was created
updated	Text	Timestamp when the diagram version was last updated
version	Number	Version number of the diagram
type	Text	Type of the diagram version

Delete Diagram Version

Delete a version of the diagram

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to delete the diagram version for
Version	Number	Yes	Version number of the diagram to delete

Output

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

{
  "data": "string",
  "status": "string"
}

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

Field descriptions

Field	Type	Description
data	Any	Result returned by the DECA Chatbot API. Its shape depends on the action: a delete may return the removed record, true, an empty object, or nothing
status	Text	"success" when the DECA Chatbot API accepted the request

Restore Diagram Version

Restore a version of the diagram

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to restore the diagram version for
Version	Number	Yes	Version number of the diagram to restore

Output

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

{
  "data": {
    "success": false
  },
  "status": "string"
}

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

Field descriptions

Field	Type	Description
data	Object	Outcome reported by the DECA Chatbot API
data.success	Yes / No	Whether the operation succeeded
status	Text	"success" when the DECA Chatbot API accepted the request

Get Integrations

Get all integrations

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to get the integrations for
Limit	Number	Yes	Limit the number of integrations to get Default: 20
Next	Text		Next cursor to get the next page of integrations
Prev	Text		Prev cursor to get the previous page of integrations

Output

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

{
  "data": [
    {
      "organizationId": "string",
      "integrationType": "line",
      "name": "string",
      "ocsChannelId": "string",
      "externalId": "string",
      "metadata": "string",
      "created": "string",
      "updated": "string",
      "configs": {},
      "integrationId": "string",
      "platform": "CHATBOX",
      "status": "ENABLE",
      "botId": "string"
    }
  ],
  "pagination": {
    "limit": 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	Data of the items
data[].organizationId	Text	ID of the organization that owns the integration
data[].integrationType	Text	Type of the integration
data[].name	Text	Name of the integration
data[].ocsChannelId	Text	OCS Channel ID of the integration
data[].externalId	Text	External ID of the integration
data[].metadata	Key–value pairs	Additional metadata for the integration
data[].created	Text	Timestamp when the integration was created
data[].updated	Text	Timestamp when the integration was last updated
data[].configs	Object	Configuration for the integration
data[].integrationId	Text	ID of the integration
data[].platform	Text	Platform of the integration, values 'CHATBOX', 'WEB', 'LINE'
data[].status	Text	Status of the integration, values 'ENABLE', 'DISABLE', 'PENDING'
data[].botId	Text	ID of the bot that owns the integration
pagination	Object	Pagination information
pagination.limit	Number	Number of items to get per page
pagination.next	Text	Next cursor to get the next page of items

Delete 3rd Party Integration

Delete a 3rd party integration

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to delete the integration for
Integration ID	Text	Yes	ID of the integration to delete

Output

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

{
  "data": "string",
  "status": "string"
}

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

Field descriptions

Field	Type	Description
data	Any	Result returned by the DECA Chatbot API. Its shape depends on the action: a delete may return the removed record, true, an empty object, or nothing
status	Text	"success" when the DECA Chatbot API accepted the request

Get Integration

Get an integration

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to get the integration for
Integration ID	Text	Yes	ID of the integration to get

Output

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

{
  "organizationId": "string",
  "integrationType": "line",
  "name": "string",
  "ocsChannelId": "string",
  "externalId": "string",
  "metadata": "string",
  "created": "string",
  "updated": "string",
  "configs": {},
  "integrationId": "string",
  "platform": "CHATBOX",
  "status": "ENABLE",
  "botId": "string"
}

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

Field descriptions

Field	Type	Description
organizationId	Text	ID of the organization that owns the integration
integrationType	Text	Type of the integration
name	Text	Name of the integration
ocsChannelId	Text	OCS Channel ID of the integration
externalId	Text	External ID of the integration
metadata	Key–value pairs	Additional metadata for the integration
created	Text	Timestamp when the integration was created
updated	Text	Timestamp when the integration was last updated
configs	Object	Configuration for the integration
integrationId	Text	ID of the integration
platform	Text	Platform of the integration, values 'CHATBOX', 'WEB', 'LINE'
status	Text	Status of the integration, values 'ENABLE', 'DISABLE', 'PENDING'
botId	Text	ID of the bot that owns the integration

Disable Integration

Disable an integration

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to disable the integration for
Integration ID	Text	Yes	ID of the integration to disable

Output

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

{
  "data": {
    "success": false
  },
  "status": "string"
}

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

Field descriptions

Field	Type	Description
data	Object	Outcome reported by the DECA Chatbot API
data.success	Yes / No	Whether the operation succeeded
status	Text	"success" when the DECA Chatbot API accepted the request

Update Flow

Update a flow

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to update the flow for
Flow ID	Text	Yes	ID of the flow to update
Name	Text		Name of the flow
Description	Text		Description of the flow
Category	Choice		Category of the flow Options: Topic, Component, Snippet

Output

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

{
  "id": "string",
  "botId": "string",
  "name": "string",
  "category": "topic",
  "type": "start",
  "description": "string",
  "creator": "string",
  "nodes": {},
  "configs": {
    "intentNodes": [
      {
        "intentScope": "string",
        "intentId": "string",
        "ID": "string"
      }
    ]
  }
}

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

Field descriptions

Field	Type	Description
id	Text	ID of the flow
botId	Text	ID of the bot that owns the flow
name	Text	Name of the flow
category	Text	Category of the flow
type	Text	Type of the flow ('start', 'timeout', 'error', 'end', 'normal')
description	Text	Description of the flow
creator	Text	Creator of the flow
nodes	Object	Nodes of the flow
configs	Object	Configuration for the flow
configs.intentNodes[]	List	Intent nodes configuration
configs.intentNodes[].intentScope	Text	Scope of the intent
configs.intentNodes[].intentId	Text	ID of the intent
configs.intentNodes[].ID	Text	ID of the flow

Delete Flow

Delete a flow

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to delete the flow for
Flow ID	Text	Yes	ID of the flow to delete

Output

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

{
  "data": "string",
  "status": "string"
}

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

Field descriptions

Field	Type	Description
data	Any	Result returned by the DECA Chatbot API. Its shape depends on the action: a delete may return the removed record, true, an empty object, or nothing
status	Text	"success" when the DECA Chatbot API accepted the request

Duplicate Flow

Duplicate a flow

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to duplicate the flow for
Flow ID	Text	Yes	ID of the flow to duplicate
Name	Text		Name of the flow

Output

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

{
  "data": "string",
  "status": "string"
}

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

Field descriptions

Field	Type	Description
data	Any
data.id	Text	ID of the flow
data.botId	Text	ID of the bot that owns the flow
data.name	Text	Name of the flow
data.category	Text	Category of the flow
data.type	Text	Type of the flow ('start', 'timeout', 'error', 'end', 'normal')
data.description	Text	Description of the flow
data.creator	Text	Creator of the flow
data.nodes	Object	Nodes of the flow
data.configs	Object	Configuration for the flow
data.configs.intentNodes[]	List	Intent nodes configuration
data.configs.intentNodes[].intentScope	Text	Scope of the intent
data.configs.intentNodes[].intentId	Text	ID of the intent
data.configs.intentNodes[].ID	Text	ID of the flow
status	Text	"success" when the DECA Chatbot API accepted the request

Create Intent

Create an intent

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to create the intent for
Label	Text	Yes	Label of the intent
Language	Choice	Yes	Language of the intent Options: English, Japanese
Utterances	List	Yes	List of utterances for the intent

Output

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

{
  "id": "string",
  "label": "string",
  "language": "en",
  "botId": "string",
  "utterances": [
    "string"
  ]
}

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

Field descriptions

Field	Type	Description
id	Text	ID of the intent
label	Text	Label of the intent
language	Text	Language of the intent
botId	Text	ID of the bot that owns the intent
utterances[]	List	List of utterances for the intent

Get Intents

Get all intents by pagination

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to get the intents for
Limit	Number	Yes	Limit the number of intents to get Default: 20
Next	Text		Next cursor to get the next page of intents
Prev	Text		Prev cursor to get the previous page of intents

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.

{
  "data": [
    {
      "id": "string",
      "label": "string",
      "language": "en",
      "botId": "string",
      "utterances": [
        "string"
      ]
    }
  ],
  "pagination": {
    "limit": 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	Data of the items
data[].id	Text	ID of the intent
data[].label	Text	Label of the intent
data[].language	Text	Language of the intent
data[].botId	Text	ID of the bot that owns the intent
data[].utterances[]	List	List of utterances for the intent
pagination	Object	Pagination information
pagination.limit	Number	Number of items to get per page
pagination.next	Text	Next cursor to get the next page of items

Get Intent

Get an intent

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to get the intent for
Intent ID	Text	Yes	ID of the intent to get

Output

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

{
  "id": "string",
  "label": "string",
  "language": "en",
  "botId": "string",
  "utterances": [
    "string"
  ]
}

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

Field descriptions

Field	Type	Description
id	Text	ID of the intent
label	Text	Label of the intent
language	Text	Language of the intent
botId	Text	ID of the bot that owns the intent
utterances[]	List	List of utterances for the intent

Update Intent

Update an intent

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to update the intent for
Intent ID	Text	Yes	ID of the intent to update
Label	Text		Label of the intent
Language	Choice		Language of the intent Options: English, Japanese
Utterances	List		List of utterances for the intent

Output

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

{
  "id": "string",
  "label": "string",
  "language": "en",
  "botId": "string",
  "utterances": [
    "string"
  ]
}

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

Field descriptions

Field	Type	Description
id	Text	ID of the intent
label	Text	Label of the intent
language	Text	Language of the intent
botId	Text	ID of the bot that owns the intent
utterances[]	List	List of utterances for the intent

Delete Intent

Delete an intent

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to delete the intent for
Intent ID	Text	Yes	ID of the intent to delete

Output

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

{
  "data": "string",
  "status": "string"
}

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

Field descriptions

Field	Type	Description
data	Any	Result returned by the DECA Chatbot API. Its shape depends on the action: a delete may return the removed record, true, an empty object, or nothing
status	Text	"success" when the DECA Chatbot API accepted the request

Create Variable

Create a variable

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to create the variable for
Name	Text	Yes	Name of the variable
Default Value	Text		Default value of the variable
Description	Text		Description of the variable

Output

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

{
  "id": "string",
  "botId": "string",
  "name": "string",
  "defaultValue": "string",
  "description": "string",
  "created": "string",
  "updated": "string"
}

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

Field descriptions

Field	Type	Description
id	Text	ID of the variable
botId	Text	ID of the bot that owns the variable
name	Text	Name of the variable
defaultValue	Text	Default value of the variable
description	Text	Description of the variable
created	Text	Timestamp when the variable was created
updated	Text	Timestamp when the variable was last updated

Get Variables

Get all variables by pagination

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to get the variables for

Output

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

[
  {
    "id": "string",
    "botId": "string",
    "name": "string",
    "defaultValue": "string",
    "description": "string",
    "created": "string",
    "updated": "string"
  }
]

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

Field descriptions

Field	Type	Description
id	Text	ID of the variable
botId	Text	ID of the bot that owns the variable
name	Text	Name of the variable
defaultValue	Text	Default value of the variable
description	Text	Description of the variable
created	Text	Timestamp when the variable was created
updated	Text	Timestamp when the variable was last updated

Update Variable

Update a variable

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to update the variable for
Variable ID	Text	Yes	ID of the variable to update
Name	Text		Name of the variable
Default Value	Text		Default value of the variable
Description	Text		Description of the variable

Output

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

{
  "id": "string",
  "botId": "string",
  "name": "string",
  "defaultValue": "string",
  "description": "string",
  "created": "string",
  "updated": "string"
}

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

Field descriptions

Field	Type	Description
id	Text	ID of the variable
botId	Text	ID of the bot that owns the variable
name	Text	Name of the variable
defaultValue	Text	Default value of the variable
description	Text	Description of the variable
created	Text	Timestamp when the variable was created
updated	Text	Timestamp when the variable was last updated

Delete Variable

Delete a variable

Settings

Field	Type	Required	Description
Bot ID	Text	Yes	ID of the bot to delete the variable for
Variable ID	Text	Yes	ID of the variable to delete

Output

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

{
  "data": "string",
  "status": "string"
}

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

Field descriptions

Field	Type	Description
data	Any	Result returned by the DECA Chatbot API. Its shape depends on the action: a delete may return the removed record, true, an empty object, or nothing
status	Text	"success" when the DECA Chatbot API accepted the request