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, the Chatbot - Send Typing operation allows a chatbot to send a "typing" indicator to a specified dialog or chat within Bitrix24. This simulates the bot actively typing a message, enhancing user experience by signaling that a response is being prepared.

Common scenarios:

  • Indicating to users that the chatbot is processing their input before sending a reply.
  • Creating more natural conversational flows in automated chatbots.
  • Improving engagement in customer support chats by showing activity.

Practical example:
A customer sends a query to a Bitrix24 chatbot. Before the bot sends the actual answer, it triggers the "Send Typing" operation to show the typing indicator for a few seconds, making the interaction feel more human-like.

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 sending the typing indicator.
Dialog ID The unique identifier of the dialog or chat where the typing indicator will be sent.
Options Additional optional parameters to 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: Description text for the bot
• Bot Avatar: URL to an avatar image for the bot
• Command Description: Description of a command
• Is Common: Boolean flag if the command is common
• Is Hidden: Boolean flag if the command is hidden
• Allow Extranet: Boolean flag to allow extranet access
• Message Type: Type of message, options are "Text" or "System"
• Attachments: JSON array of attachments
• Keyboard Buttons: JSON array defining 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

Output

The node outputs an array of items corresponding to the processed requests. Each item contains a json field with the response data from Bitrix24 after sending the typing indicator.

  • The exact structure of the json output depends on the Bitrix24 API response for the "sendTyping" action.
  • If an error occurs and "Continue On Fail" is enabled, the output includes an error field with the error message, along with metadata such as resource name and timestamp.
  • The node does not output binary data.

Dependencies

  • Requires connection to a Bitrix24 instance via one of the supported authentication methods:
    • OAuth2 authentication (recommended)
    • Webhook URL
    • API key authentication
  • Proper configuration of credentials in n8n is necessary to authenticate API calls.
  • The node relies on Bitrix24's REST API endpoints to perform actions.

Troubleshooting

  • Common issues:

    • Invalid or expired authentication tokens causing authorization failures.
    • Incorrect Bot ID or Dialog ID leading to "not found" errors.
    • Insufficient permissions for the bot to send typing indicators in the specified dialog.
    • Malformed JSON in options like attachments or keyboard buttons causing request failures.

  • Error messages and resolutions:

    • "error": "Invalid authentication": Check and refresh your API credentials or OAuth2 token.
    • "error": "Bot ID not found": Verify the Bot ID is correct and the bot is registered in Bitrix24.
    • "error": "Dialog ID invalid": Confirm the dialog/chat ID exists and the bot has access.
    • JSON parsing errors: Ensure all JSON fields (attachments, keyboardButtons, customParameters) are valid JSON strings.

  • Enabling "Continue On Fail" can help handle errors gracefully during workflow execution.

Links and References

Discussion