Actions4
Overview
This node integrates with the Chatforma API to manage and interact with chatbot-related data and messaging. It supports actions such as retrieving information about bots, forms, lists, users, dialogs, and dialog messages; sending text messages to users or segments; and managing user membership in lists (adding or deleting users).
Common scenarios where this node is useful include:
- Fetching bot configurations or user lists for analysis or further processing.
- Sending targeted text message campaigns to specific user segments or individual users.
- Managing user subscriptions to different segments or lists within a bot.
- Retrieving dialog histories or messages for customer support or auditing.
Practical examples:
- Automatically send a welcome message to new users added to a segment.
- Retrieve all active bots to display in a dashboard.
- Add or remove users from marketing lists based on external triggers.
- Send a custom message to a user’s dialog in response to an event.
Properties
| Name | Meaning |
|---|---|
| Действие | Action to perform: "Получить" (get), "Отправить" (send), "Добавить" (add), "Удалить" (delete) |
| Объект | Object to get when action is "Получить": Bots, Forms, Lists, Users, Dialogs, Dialog Messages |
| Бот Id / bot_id / get_bot_id / list_bot_id | Bot ID used in various operations depending on action and object |
| ID списка / list_list_id / list_id | List/segment ID used for adding/removing users or sending segment dispatch messages |
| ID пользователя / user_id / get_user_id / list_user_id | User ID (BotUserId) used for sending messages or managing list membership |
| Текст сообщения / content | Text content of the message to send |
| Объект (operation for send) | Operation type when sending: segment_dispatch, dispatch, message_to_dialog, message |
| ID сообщения / message_id | Message ID used when approving a message in a bot |
Output
The node outputs the JSON response returned by the Chatforma API for the requested operation. This typically includes data structures corresponding to the requested resource or confirmation of the performed action.
For example:
- When fetching bots, it returns an array of bot objects.
- When sending messages, it returns the status or details of the sent message.
- When adding or deleting users from lists, it returns confirmation of the update.
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 the Chatforma API endpoint
https://api.pro.chatforma.com/public/v1/.
Troubleshooting
- Missing credentials error: If no API key credential is provided, the node throws an error "No credentials got returned!". Ensure that a valid API key credential is configured in n8n.
- Invalid Bot/User/List IDs: Providing incorrect or non-existent IDs will result in API errors. Verify IDs before use.
- API rate limits or network issues: Network failures or API throttling may cause request failures. Check connectivity and API usage limits.
- Incorrect action/object combinations: Selecting unsupported combinations of action and object parameters may lead to unexpected behavior or errors. Follow the property options carefully.
Links and References
- Chatforma API Documentation (general reference, not linked in code)
- Axios HTTP client: https://axios-http.com/
Note: All internal credential names and service identifiers have been generalized to comply with guidelines.