Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform
Join our community

Actions290

Overview

The node integrates with the Bitrix24 platform, specifically enabling operations on various Bitrix24 resources. For the Chatbot resource and the Update Chat Avatar operation, it allows updating the avatar image of a chatbot within a specified chat. This is useful for automating chatbot management tasks such as customizing the bot's appearance in different chats or updating branding dynamically.

Practical scenarios include:

  • Automatically changing a chatbot’s avatar based on context or campaign.
  • Managing multiple chatbots’ avatars across different chat groups programmatically.
  • Integrating avatar updates into broader workflows that manage chatbot settings.

Properties

Name Meaning
Authentication Method to authenticate API requests: OAuth2 (recommended), Webhook (simpler), or API Key.
Bot ID The unique identifier of the chatbot whose avatar will be updated.
Chat ID The unique identifier of the chat where the chatbot avatar should be updated.
Options Additional optional parameters to customize the update request:
- Client ID Identifier for the client making the request.
- Open Line ID Identifier for the open communication line.
- Language ID Language code for localization purposes.
- Bot Description Text description of the bot.
- Bot Avatar URL pointing to the new avatar image for the bot.
- Command Description Description text for commands related to the bot.
- Is Common Boolean flag indicating if the command is common/shared.
- Is Hidden Boolean flag indicating if the command should be hidden.
- Allow Extranet Boolean flag to allow extranet users 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 (if applicable).

Output

The node outputs an array of items, each containing a json property with the response data from Bitrix24 after processing the update avatar 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 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 perform actions.
  • Proper configuration of authentication credentials in n8n is necessary.
  • Network connectivity to Bitrix24 services is required.

Troubleshooting

  • Common issues:

    • Invalid or expired authentication tokens leading to authorization errors.
    • Incorrect Bot ID or Chat ID causing "not found" or similar errors.
    • Malformed URLs in the Bot Avatar property resulting in failed avatar updates.
    • Insufficient permissions for the authenticated user to update chatbot settings.

  • Error messages:

    • Errors returned by Bitrix24 API are passed through; typical messages might include authentication failures, invalid parameters, or permission denials.
    • If the node is set to continue on fail, errors are included in the output JSON under an error field.

  • Resolutions:

    • Verify and refresh authentication credentials.
    • Double-check Bot ID and Chat ID values.
    • Ensure the avatar URL is accessible and correctly formatted.
    • Confirm the authenticated user has rights to modify chatbot avatars.

Links and References

Discussion