Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform
Join our community

Actions290

Overview

The Bitrix24 node enables interaction with the Bitrix24 CRM and business platform. Specifically, for the Chatbot resource and the Get Chat operation, this node retrieves information about a specific chat within Bitrix24's chatbot environment.

This node is useful in scenarios where you want to programmatically access chat details such as messages, participants, or metadata from a Bitrix24 chat. For example, it can be used to fetch chat history for analysis, monitor conversations for customer support automation, or integrate chat data into other workflows.

Properties

Name Meaning
Authentication Method of authenticating with Bitrix24. Options:
- OAuth2 (recommended for production)
- Webhook (simpler but less secure)
- API Key authentication
Bot ID The unique identifier of the chatbot involved in the operation. Required for most chatbot-related operations except some command registrations.
Chat ID The unique identifier of the chat whose information is being retrieved. Required for chat-specific operations like Get Chat.
Options Additional optional parameters that customize the request. These include:
- Client ID: Identifier for the client making the request
- Open Line ID: Identifier for open line integration
- Language ID: Language code
- Bot Description: Text description of the bot
- Bot Avatar: URL to the bot's avatar image
- Command Description: Description text for commands
- Is Common: Boolean flag indicating if a command is common
- Is Hidden: Boolean flag indicating if a command is hidden
- Allow Extranet: Boolean flag to allow extranet access
- Message Type: Type of message, either "text" or "system"
- Attachments: JSON array describing attachments
- Keyboard Buttons: JSON array describing keyboard layout
- URL Preview: Boolean to enable/disable URL preview
- Custom Parameters: JSON object for any additional custom parameters
- Access Token: String token for authentication (alternative to main authentication method)

Output

  • The node outputs an array of items, each containing a json property.
  • The json output contains the data returned by the Bitrix24 API for the requested chat, which typically includes chat details such as messages, participants, timestamps, and metadata.
  • If an error occurs and the node is configured to continue on failure, the output will contain an error field with the error message, along with the resource name and a timestamp.
  • The node does not explicitly output binary data.

Dependencies

  • Requires connection to Bitrix24 via one of the supported authentication methods:
    • OAuth2 authentication (recommended)
    • Webhook URL
    • API key authentication
  • Requires appropriate credentials configured in n8n for the chosen authentication method.
  • Relies on Bitrix24 API endpoints to fetch chat data.
  • No additional external dependencies beyond Bitrix24 API access.

Troubleshooting

  • Common Issues:

    • Invalid or expired authentication credentials may cause authorization errors.
    • Incorrect Bot ID or Chat ID will result in API errors or empty responses.
    • Improperly formatted JSON in options like attachments or keyboard buttons can cause request failures.
    • Network connectivity issues can prevent successful API calls.

  • Error Messages:

    • Errors thrown by the node will include the error message from the Bitrix24 API.
    • If "Continue On Fail" is enabled, errors are returned in the output JSON under the error field.
    • To resolve errors, verify credentials, ensure IDs are correct, and check JSON formatting in options.

Links and References

Discussion