Actions4
Overview
This node integrates with the Chatforma API to manage bots, forms, user lists, dialogs, and messages. It supports actions such as retrieving data, sending text messages, and managing users in lists. Typical use cases include automating chatbot interactions, broadcasting messages to user segments, managing user subscriptions, and fetching bot-related data for analytics or further processing.
Practical examples:
- Sending a text broadcast message to a selected user segment.
- Adding or removing users from specific bot segments (lists).
- Retrieving lists of bots, forms, users, or dialog messages for reporting or automation workflows.
- Sending direct messages to individual users or dialogs.
Properties
| Name | Meaning |
|---|---|
| Действие | Action to perform: Получить (get), Отправить (send), Добавить (add), Удалить (delete) |
| Объект | Object to retrieve when action is "Получить": Боты (bots), Формы (forms), Списки (lists), Пользователи (users), Диалоги (dialogs), Сообщения диалогов (dialogs_messages) |
| Бот Id (list_bot_id) | Bot ID used when adding or deleting users from lists |
| ID списка (list_list_id) | List ID used when adding or deleting users from lists |
| ID пользователя (list_user_id) | User BotUserId used when adding or deleting users from lists |
| Объект (operation) | Operation to perform when action is "Отправить" (send): Текстовая рассылка списку (segment_dispatch), Текстовая рассылка пользователю (dispatch), Сообщение в диалог пользователю (message_to_dialog), Сообщение пользователю (message) |
| Бот Id (bot_id) | Bot ID used for sending messages |
| Бот ID (get_bot_id) | Bot ID used for retrieving objects other than bots |
| ID пользователя (get_user_id) | User ID used when retrieving dialog messages |
| Список пользователей (list_id) | User list ID used for segment dispatch |
| ID пользователя (user_id) | BotUserId of the user receiving a message |
| Текст сообщения (content) | Text content of the message to send |
| ID сообщения (message_id) | Message ID used when sending a specific message to a user |
Output
The node outputs JSON data returned by the Chatforma API corresponding to the requested action and object. The structure varies depending on the endpoint called but generally includes details about bots, forms, lists, users, dialogs, messages, or confirmation of sent messages or modifications.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating requests to the Chatforma API.
- Uses the Axios HTTP client library internally to make REST API calls.
- The node expects network access to
https://api.pro.chatforma.com.
Troubleshooting
- Missing credentials error: If no API key credential is provided, the node will throw an error indicating missing credentials. Ensure that a valid API key is configured in n8n credentials.
- Invalid IDs or parameters: Providing incorrect bot IDs, user IDs, list IDs, or message IDs may result in API errors or empty responses. Verify these values before running the node.
- API rate limits or connectivity issues: Network problems or API rate limiting can cause request failures. Check network connectivity and API usage limits.
- Unexpected response structure: Since the output depends on the API response, changes in the Chatforma API could affect the node's output format.
Links and References
- Chatforma API Documentation (official API docs, if available)
- Axios GitHub Repository (HTTP client used internally)