Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform
Join our community

Actions290

Overview

The Bitrix24 node allows interaction with the Bitrix24 CRM and business platform. Specifically, the "Chatbot" resource with the "Update Chat Color" operation enables users to change the color of a chat associated with a chatbot in Bitrix24. This can be useful for visually organizing chats or customizing the chat appearance to match branding or user preferences.

Practical examples include:

  • Automatically updating chat colors based on certain triggers or events.
  • Customizing chat interfaces for different teams or projects.
  • Enhancing user experience by color-coding chats managed by chatbots.

Properties

Name Meaning
Authentication Method of authentication: OAuth2 (recommended), Webhook (simpler but less secure), or API Key.
Bot ID The unique identifier of the chatbot whose chat color is to be updated.
Chat ID The unique identifier of the chat where the color will be updated.
Color The color code (e.g., hex code) to set as the new chat color.
Options Additional optional parameters that can be provided:
- Client ID Identifier for the client making the request.
- Open Line ID Identifier for the open line (communication channel).
- Language ID Language code for localization purposes.
- 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 the command is common/shared.
- Is Hidden Boolean indicating if the command should be hidden.
- Allow Extranet Boolean indicating if extranet access is allowed.
- Message Type Type of message: "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 property with the response data from Bitrix24 after processing the update chat color request. If an error occurs and the node is configured to continue on failure, the output includes an error object with the error message, resource name, and timestamp.

No binary data output is indicated.

Dependencies

  • Requires connection to Bitrix24 via one of the supported authentication methods: OAuth2, webhook URL, or API key.
  • Proper credentials must be configured in n8n for the chosen authentication method.
  • Network access to Bitrix24 API endpoints is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Bot ID or Chat ID will cause the operation to fail.
    • Incorrect color code format may result in errors or no visible change.
    • Authentication failures due to invalid or expired tokens.
    • Insufficient permissions for the authenticated user or bot to update chat properties.

  • Error messages:

    • Errors returned from Bitrix24 API are passed through; typical messages might indicate authorization failure, invalid parameters, or resource not found.
    • If the node is set to continue on fail, errors are included in the output JSON under an error field.

  • Resolutions:

    • Verify Bot ID and Chat ID correctness.
    • Ensure color codes conform to expected formats (e.g., hex color strings).
    • Refresh or reconfigure authentication credentials.
    • Confirm the bot has appropriate permissions in Bitrix24.

Links and References

Discussion