Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform
Join our community

Actions290

Overview

The Bitrix24 node integrates with the Bitrix24 CRM and business platform, enabling automation of various operations related to CRM entities, chatbots, messages, and more. Specifically, for the Chatbot - Unregister Command operation, this node allows users to unregister (remove) a specific command from a chatbot within Bitrix24.

This operation is useful when you want to dynamically manage chatbot commands, such as disabling obsolete commands or cleaning up commands that are no longer needed. For example, if your chatbot has a command for "Help" that you want to remove after an update, you can use this node operation to unregister that command programmatically.

Properties

Name Meaning
Authentication Method of authentication to connect to Bitrix24. Options:
- OAuth2 (recommended for production)
- Webhook (simpler but less secure)
- API Key
Bot ID The unique identifier of the chatbot from which the command will be unregistered.
Command ID The unique identifier of the command to unregister from the chatbot.
Options Additional optional parameters to customize the request:
- Client ID: Identifier for the client making the request.
- Open Line ID: Identifier for open communication line.
- Language ID: Language code.
- Bot Description: Description text for the bot.
- Bot Avatar: URL to the bot's avatar image.
- Command Description: Description of the command.
- Is Common: Boolean indicating if the command is common.
- Is Hidden: Boolean indicating if the command is hidden.
- Allow Extranet: Boolean indicating if extranet access is allowed.
- 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 override.

Output

The node outputs an array of items where each item contains a json property representing the response from Bitrix24 after attempting to unregister the command. The structure typically includes:

  • Confirmation of success or failure.
  • Any error messages if the operation failed.
  • Metadata such as timestamps and resource type.

If the operation fails and the node is configured to continue on failure, the output will include an error object with the error message and timestamp.

No binary data output is indicated for this operation.

Dependencies

  • Requires connection to a Bitrix24 instance.
  • Requires one of the following authentication methods configured in n8n:
    • OAuth2 credentials
    • Webhook URL
    • API key credential
  • Proper permissions in Bitrix24 to manage chatbot commands.
  • Network access to Bitrix24 API endpoints.

Troubleshooting

  • Common Issues:

    • Invalid or missing Bot ID or Command ID will cause the operation to fail.
    • Insufficient permissions or incorrect authentication credentials may result in authorization errors.
    • Network connectivity issues can prevent API calls from succeeding.
    • Malformed JSON in options like attachments or keyboard buttons can cause parsing errors.

  • Error Messages:

    • Errors returned by Bitrix24 API will be included in the output JSON under an error field.
    • If the node is set to continue on failure, errors will not stop workflow execution but will be reported in the output.
    • Typical errors include "Command not found", "Unauthorized", or "Invalid parameters".

  • Resolution Tips:

    • Verify Bot ID and Command ID correctness.
    • Ensure authentication credentials are valid and have required scopes.
    • Validate JSON fields in options before sending.
    • Check network connectivity and firewall settings.

Links and References

Discussion