Skip to main content
Chatforma logo
  • Category: ai chatbots
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: CHATFORMA
  • Version: 20261030_00

Tools

Slug: CHATFORMA_GET_USER_VARIABLEGet the current value of one bot variable for one bot user.

Input Parameters

integer
required
Bot ID returned by CHATFORMA_LIST_BOTS.
integer
required
Bot user ID returned by CHATFORMA_LIST_USERS.
integer
required
Variable ID returned by CHATFORMA_LIST_VARIABLES.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATFORMA_LIST_BOTSList bots belonging to the connected Chatforma account so their IDs can be used in bot-scoped tools.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATFORMA_LIST_DIALOG_MESSAGESReturn one page of messages exchanged in a specific user’s bot dialog, with a cursor for continuing the history.

Input Parameters

integer
required
Bot ID returned by CHATFORMA_LIST_BOTS.
integer
required
Dialog user ID returned by CHATFORMA_LIST_USERS with view=open_dialogs.
integer
Requested messages per page. Chatforma documents a default of 30 but no maximum.
string
Continuation cursor returned by a prior call. Omit for the first page and pass it back unchanged to continue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATFORMA_LIST_PREDEFINED_MESSAGESList predefined messages configured in a bot so a message ID can be selected for sending.

Input Parameters

integer
required
Bot ID returned by CHATFORMA_LIST_BOTS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATFORMA_LIST_SEGMENTSList the user segments configured for a bot, including segment IDs needed for targeted sends.

Input Parameters

integer
required
Bot ID returned by CHATFORMA_LIST_BOTS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATFORMA_LIST_USERSList a bot’s users, members of one segment, or users with open dialogs; choose the view that matches the task.

Input Parameters

string ("bot_users" | "segment_members" | "open_dialogs")
Which user collection to return: all bot users, members of one segment, or users with open dialogs.
integer
required
Bot ID returned by CHATFORMA_LIST_BOTS.
boolean
For bot_users only, return deleted users instead of active users.
integer
For bot_users or open_dialogs, requested records per page. Chatforma does not document a maximum, and defaults bot_users to 100.
string
Segment ID returned by CHATFORMA_LIST_SEGMENTS. Required only when view is segment_members.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATFORMA_LIST_VARIABLESList variables configured for a bot, including IDs and types needed to read user-specific values.

Input Parameters

integer
required
Bot ID returned by CHATFORMA_LIST_BOTS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATFORMA_SEND_DIALOG_MESSAGEImmediately send a user-visible text message into a specific user’s bot dialog. This irreversible action may contact a real user.

Input Parameters

integer
required
Bot ID returned by CHATFORMA_LIST_BOTS.
string
required
Text to send to the user. Sending is immediate and cannot be undone.
integer
required
Dialog user ID returned by CHATFORMA_LIST_USERS with view=open_dialogs.
string
required
Unique client-generated ID for this message, used to recognize the sender’s own message and avoid accidental duplicate identifiers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATFORMA_SEND_PREDEFINED_MESSAGESend 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

integer
required
Bot ID returned by CHATFORMA_LIST_BOTS.
string
For a segment dispatch only, schedule delivery for this ISO 8601 date-time; omit to dispatch immediately.
string
required
Predefined message ID returned by CHATFORMA_LIST_PREDEFINED_MESSAGES.
string
Segment ID returned by CHATFORMA_LIST_SEGMENTS. Required only when recipient_type is segment.
integer
Bot user ID. Required only when recipient_type is user.
string ("user" | "segment")
required
Send to one bot user or dispatch to every user in a segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATFORMA_SEND_TEXT_DISPATCHCreate 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

integer
required
Bot ID returned by CHATFORMA_LIST_BOTS.
string
For a single-user dispatch only, schedule delivery for this ISO 8601 date-time; omit to dispatch immediately.
string
required
Text content delivered to the selected recipient or audience. Sending cannot be undone through this API.
string
Segment ID returned by CHATFORMA_LIST_SEGMENTS. Required only when recipient_type is segment; use 0 to target all bot users.
integer
Bot user ID. Required only when recipient_type is user.
string ("user" | "segment")
required
Dispatch to one bot user or every user in a segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not