Actions290
- Task Actions
- Direct API Actions
- CRM Actions
- User Actions
- SPA Actions
- Activity Actions
- Automation Actions
- Document Generator Actions
- Data Storage Actions
- Get Entity
- Add Entity
- Update Entity
- Delete Entity
- Get Entity Rights
- Get Entity Sections
- Add Entity Section
- Update Entity Section
- Delete Entity Section
- Get Entity Item
- Add Entity Item
- Update Entity Item
- Delete Entity Item
- Get Entity Item Properties
- Add Entity Item Property
- Update Entity Item Property
- Delete Entity Item Property
- Chat Actions
- User Field Actions
- File Actions
- User Field Config Actions
- Duplicate Actions
- Timeline Actions
- Disk Actions
- Upload File
- Download File
- Delete File
- Get File Info
- List Files
- Create Folder
- Delete Folder
- Get Storage Info
- Get Storages
- Get Storage
- Get Folders
- Get Folder
- Add Folder
- Update Folder
- Copy Folder
- Move Folder
- Rename Folder
- Get Files
- Get File
- Copy File
- Move File
- Rename File
- Share Item
- Get Shared Items
- Get Sharing Rights
- Update Sharing Rights
- Workflow Actions
- Status Actions
- Calendar Actions
- Chatbot Actions
- Events Actions
- Lists Actions
- Product Actions
- Open Lines Actions
- Telephony Actions
- Register External Call
- Finish External Call
- Hide External Call
- Show External Call
- Search CRM Entities
- Attach Call Record
- Get External Line
- Add External Line
- Update External Line
- Delete External Line
- Get Voximplant Statistics
- Get Voximplant Line
- Get Voximplant SIP Connector
- Get Voximplant SIP Line
- Add Voximplant SIP Line
- Update Voximplant SIP Line
- Delete Voximplant SIP Line
- Message Service Actions
- Notify Actions
Overview
The "Unregister Bot" operation in the Chatbot resource allows users to remove a previously registered chatbot from their Bitrix24 environment. This is useful when you want to deactivate or delete a bot that is no longer needed, helping to keep your workspace clean and avoid unnecessary bot activity.
Common scenarios include:
- Removing test or development bots after testing.
- Decommissioning bots that are outdated or replaced by newer versions.
- Managing bot lifecycle within automated workflows.
For example, if you have a chatbot integrated with your Bitrix24 account for customer support but decide to discontinue it, you can use this operation to unregister it cleanly.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authentication to use: OAuth2 (recommended), Webhook URL (simpler), or API Key. |
| Bot ID | The unique identifier of the chatbot to unregister. |
| Options | Additional optional parameters to customize the request: |
| - Client ID | Identifier for the client making the request. |
| - Open Line ID | Identifier for the Open Line channel associated with the bot. |
| - Language ID | Language code for localization purposes. |
| - Bot Description | Text description of the bot. |
| - Bot Avatar | URL pointing to the bot's avatar image. |
| - 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 access to the bot. |
| - Message Type | Type of message sent by the bot: "Text" or "System". |
| - Attachments | JSON array describing attachments to include in messages. |
| - Keyboard Buttons | JSON array defining keyboard layout/buttons for bot interaction. |
| - URL Preview | Boolean to enable or disable URL preview in messages. |
| - Custom Parameters | JSON object for any additional custom parameters required by the API. |
| - Access Token | Access token string used for authentication if applicable. |
Output
The node outputs an array of items where each item contains a json property representing the response from the Bitrix24 API regarding the unregister bot operation. Typically, this will include confirmation of success or details about any errors encountered.
If the operation involves binary data (not typical for unregistering a bot), it would be summarized accordingly, but here the output is purely JSON-based.
Example output structure:
[
{
"json": {
"result": true,
"details": "Bot unregistered successfully"
}
}
]
Or in case of failure (if continueOnFail is enabled):
[
{
"json": {
"error": "Error message",
"resource": "chatbot",
"timestamp": "2024-06-01T12:00:00.000Z"
},
"pairedItem": {
"item": 0
}
}
]
Dependencies
- Requires a valid Bitrix24 account with appropriate permissions to manage chatbots.
- Needs one of the supported authentication methods configured in n8n:
- OAuth2 authentication (recommended for production).
- Bitrix24 webhook URL.
- Bitrix24 API key.
- The node depends on Bitrix24 API endpoints to perform the unregister operation.
- No additional external libraries beyond those bundled with the node are required.
Troubleshooting
Common Issues:
- Invalid or missing Bot ID: Ensure the Bot ID provided exists and is correct.
- Authentication failures: Verify that the selected authentication method is properly configured and tokens/keys are valid.
- Insufficient permissions: The user or token must have rights to unregister bots.
- Network or API errors: Check connectivity and Bitrix24 service status.
Error Messages:
"error": "Invalid Bot ID": Confirm the Bot ID is correct."error": "Authentication failed": Reauthenticate or check credentials."error": "Access denied": Ensure the authenticated user has permission to unregister bots.- Other API error messages will be passed through; consult Bitrix24 API documentation for details.
Resolution Tips:
- Double-check all input parameters.
- Test authentication separately.
- Enable "Continue On Fail" in the node settings to handle errors gracefully in workflows.