Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform
Join our community

Actions290

Overview

The node integrates with the Bitrix24 platform, specifically enabling interaction with its chatbot features. The "Add Chat User" operation allows users to add one or more users to a specific chat within a Bitrix24 chatbot environment. This is useful for automating chat membership management, such as adding team members to group chats or including clients in support conversations.

Practical examples include:

  • Automatically adding new sales team members to a sales-related chat.
  • Adding customers to a support chat when they initiate a conversation.
  • Managing chat participants dynamically based on workflow conditions.

Properties

Name Meaning
Authentication Method of authenticating with Bitrix24: OAuth2 (recommended), Webhook (simpler), or API Key.
Bot ID Identifier of the chatbot that manages the chat.
Chat ID Identifier of the chat where users will be added.
User IDs Comma-separated list of user IDs to add to the chat.
Options Additional optional parameters:
- Client ID Client identifier for the request.
- Open Line ID Identifier for an open communication line.
- Language ID Language code for localization.
- Bot Description Description text for the bot.
- Bot Avatar URL pointing to the bot's avatar image.
- Command Description Description of a command related to the bot.
- Is Common Boolean indicating if a command is common.
- Is Hidden Boolean indicating if a command is hidden.
- Allow Extranet Boolean indicating whether extranet users are allowed access.
- Message Type Type of message sent: "Text" or "System".
- Attachments JSON array describing attachments to include.
- Keyboard Buttons JSON array defining keyboard layout/buttons.
- URL Preview Boolean to enable or disable URL preview in messages.
- Custom Parameters JSON object for any additional custom parameters.
- Access Token Access token string for authentication purposes.

Output

The node outputs an array of items, each containing a json field with the response from Bitrix24 after attempting to add users to the chat. The structure typically includes success confirmation or error details.

If the operation fails and the node is configured to continue on failure, the output item will contain an error field with the error message, the resource name, and a timestamp.

No binary data output is indicated for this operation.

Dependencies

  • Requires valid authentication credentials for Bitrix24 via one of the supported methods: OAuth2, webhook URL, or API key.
  • The node depends on Bitrix24 API endpoints to manage chat users.
  • Proper configuration of authentication credentials in n8n is necessary.
  • Network connectivity to Bitrix24 services is required.

Troubleshooting

  • Common Issues:

    • Invalid or expired authentication tokens can cause authorization failures.
    • Incorrect Bot ID or Chat ID may result in errors indicating the chat or bot was not found.
    • Malformed User IDs (e.g., wrong format or non-existent users) can cause partial or complete failure.
    • Insufficient permissions for the authenticated user/bot to modify chat membership.

  • Error Messages:

    • Errors returned by Bitrix24 API will be included in the output under the error field if "Continue On Fail" is enabled.
    • Typical errors include authentication failures, invalid parameters, or permission denials.

  • Resolution Tips:

    • Verify that the authentication method and credentials are correctly set up and valid.
    • Double-check Bot ID, Chat ID, and User IDs for correctness.
    • Ensure the bot has sufficient rights to add users to the specified chat.
    • Review Bitrix24 API limits and quotas if requests fail unexpectedly.

Links and References

Discussion