Skip to main content
GET
Get a bot flow

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the bot flow.

Example:

1

Response

Success

id
integer

The numeric ID of the flow.

name
string

The flow name.

slug
string

Generated from the name when you do not send one. Unique within the account.

description
string | null

Internal description.

bot_name
string

The name the bot uses when it speaks to a contact.

bot_avatar_url
string | null

Avatar shown beside the bot's messages.

bot_greeting
string | null

Opening line, if the flow uses one.

status
enum<string>

Only a published flow runs against live conversations.

Available options:
draft,
published,
archived
priority
integer

Higher wins when several flows match the same conversation.

inbox_id
integer

The inbox the flow runs in.

trigger_definition
object

When the flow fires, as {"op": "all", "conditions": [...]}. Required, and must be an object.

published_version_id
integer | null

The version currently live. Null until the flow is published.

latest_version
object

Present on the list response: the newest version, which is not necessarily the published one.

versions
object[]

Present on single-flow responses: every version, newest first.

created_at
string

ISO-8601 timestamp.

updated_at
string

ISO-8601 timestamp.