> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Chatforma

> Chatforma is a chatbot automation platform for managing bots, users, segments, broadcasts, dialogs, forms, notifications, and variables.

![Chatforma logo](https://mintcdn.com/composio-preview/PudKL42NVsy5O-ND/images/toolkits/chatforma.svg?fit=max\&auto=format\&n=PudKL42NVsy5O-ND\&q=85\&s=791c1bb5e3e292234c0c2ace2687638a)

* **Category:** ai chatbots
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 10
* **Triggers:** 0
* **Slug:** `CHATFORMA`
* **Version:** 20261030\_00

## Tools

> [accordion] Get User Variable
>
> **Slug:** `CHATFORMA_GET_USER_VARIABLE`
>
> Get the current value of one bot variable for one bot user.
>
> #### Input Parameters
>
> **bot\_id** `integer` *required*
>
> Bot ID returned by CHATFORMA\_LIST\_BOTS.
>
> **bot\_user\_id** `integer` *required*
>
> Bot user ID returned by CHATFORMA\_LIST\_USERS.
>
> **variable\_id** `integer` *required*
>
> Variable ID returned by CHATFORMA\_LIST\_VARIABLES.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Bots
>
> **Slug:** `CHATFORMA_LIST_BOTS`
>
> List bots belonging to the connected Chatforma account so their IDs can be used in bot-scoped tools.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Dialog Messages
>
> **Slug:** `CHATFORMA_LIST_DIALOG_MESSAGES`
>
> Return one page of messages exchanged in a specific user's bot dialog, with a cursor for continuing the history.
>
> #### Input Parameters
>
> **bot\_id** `integer` *required*
>
> Bot ID returned by CHATFORMA\_LIST\_BOTS.
>
> **user\_id** `integer` *required*
>
> Dialog user ID returned by CHATFORMA\_LIST\_USERS with view=open\_dialogs.
>
> **per\_page** `integer`
>
> Requested messages per page. Chatforma documents a default of 30 but no maximum.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a prior call. Omit for the first page and pass it back unchanged to continue.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Predefined Messages
>
> **Slug:** `CHATFORMA_LIST_PREDEFINED_MESSAGES`
>
> List predefined messages configured in a bot so a message ID can be selected for sending.
>
> #### Input Parameters
>
> **bot\_id** `integer` *required*
>
> Bot ID returned by CHATFORMA\_LIST\_BOTS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Segments
>
> **Slug:** `CHATFORMA_LIST_SEGMENTS`
>
> List the user segments configured for a bot, including segment IDs needed for targeted sends.
>
> #### Input Parameters
>
> **bot\_id** `integer` *required*
>
> Bot ID returned by CHATFORMA\_LIST\_BOTS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Users
>
> **Slug:** `CHATFORMA_LIST_USERS`
>
> List a bot's users, members of one segment, or users with open dialogs; choose the view that matches the task.
>
> #### Input Parameters
>
> **view** `string ("bot_users" | "segment_members" | "open_dialogs")`
>
> Which user collection to return: all bot users, members of one segment, or users with open dialogs.
>
> **bot\_id** `integer` *required*
>
> Bot ID returned by CHATFORMA\_LIST\_BOTS.
>
> **deleted** `boolean`
>
> For bot\_users only, return deleted users instead of active users.
>
> **per\_page** `integer`
>
> For bot\_users or open\_dialogs, requested records per page. Chatforma does not document a maximum, and defaults bot\_users to 100.
>
> **segment\_id** `string`
>
> Segment ID returned by CHATFORMA\_LIST\_SEGMENTS. Required only when view is segment\_members.
>
> **next\_cursor** `string`
>
> For bot\_users or open\_dialogs, continuation cursor returned by a prior call. Repeat the same view and omit it for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Variables
>
> **Slug:** `CHATFORMA_LIST_VARIABLES`
>
> List variables configured for a bot, including IDs and types needed to read user-specific values.
>
> #### Input Parameters
>
> **bot\_id** `integer` *required*
>
> Bot ID returned by CHATFORMA\_LIST\_BOTS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Dialog Message
>
> **Slug:** `CHATFORMA_SEND_DIALOG_MESSAGE`
>
> Immediately send a user-visible text message into a specific user's bot dialog. This irreversible action may contact a real user.
>
> #### Input Parameters
>
> **bot\_id** `integer` *required*
>
> Bot ID returned by CHATFORMA\_LIST\_BOTS.
>
> **message** `string` *required*
>
> Text to send to the user. Sending is immediate and cannot be undone.
>
> **user\_id** `integer` *required*
>
> Dialog user ID returned by CHATFORMA\_LIST\_USERS with view=open\_dialogs.
>
> **idempotency\_key** `string` *required*
>
> Unique client-generated ID for this message, used to recognize the sender's own message and avoid accidental duplicate identifiers.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Predefined Message
>
> **Slug:** `CHATFORMA_SEND_PREDEFINED_MESSAGE`
>
> Send a configured bot message to one user or dispatch it to a segment. This irreversible action may contact one or many real users.
>
> #### Input Parameters
>
> **bot\_id** `integer` *required*
>
> Bot ID returned by CHATFORMA\_LIST\_BOTS.
>
> **run\_at** `string`
>
> For a segment dispatch only, schedule delivery for this ISO 8601 date-time; omit to dispatch immediately.
>
> **message\_id** `string` *required*
>
> Predefined message ID returned by CHATFORMA\_LIST\_PREDEFINED\_MESSAGES.
>
> **segment\_id** `string`
>
> Segment ID returned by CHATFORMA\_LIST\_SEGMENTS. Required only when recipient\_type is segment.
>
> **bot\_user\_id** `integer`
>
> Bot user ID. Required only when recipient\_type is user.
>
> **recipient\_type** `string ("user" | "segment")` *required*
>
> Send to one bot user or dispatch to every user in a segment.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Text Dispatch
>
> **Slug:** `CHATFORMA_SEND_TEXT_DISPATCH`
>
> Create a user-visible text dispatch for one bot user or a segment. Delivery may be immediate or scheduled where supported and cannot be undone through this API.
>
> #### Input Parameters
>
> **bot\_id** `integer` *required*
>
> Bot ID returned by CHATFORMA\_LIST\_BOTS.
>
> **run\_at** `string`
>
> For a single-user dispatch only, schedule delivery for this ISO 8601 date-time; omit to dispatch immediately.
>
> **content** `string` *required*
>
> Text content delivered to the selected recipient or audience. Sending cannot be undone through this API.
>
> **segment\_id** `string`
>
> Segment ID returned by CHATFORMA\_LIST\_SEGMENTS. Required only when recipient\_type is segment; use 0 to target all bot users.
>
> **bot\_user\_id** `integer`
>
> Bot user ID. Required only when recipient\_type is user.
>
> **recipient\_type** `string ("user" | "segment")` *required*
>
> Dispatch to one bot user or every user in a segment.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
