Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform

Actions89

Overview

This node allows users to interact directly with the Bitrix24 REST API by calling any Bitrix24 API endpoint. It is designed for advanced use cases where predefined resource-operation pairs are insufficient or when custom API calls are needed. Users can specify the exact API method to call and provide JSON data as the request body.

Common scenarios include:

  • Accessing Bitrix24 features not yet supported by built-in operations.
  • Performing batch or complex queries using Bitrix24's native API methods.
  • Integrating custom workflows that require direct API access to Bitrix24 CRM, tasks, users, or other modules.

Practical example:

  • Calling crm.lead.list to retrieve a list of leads with specific filters.
  • Creating a new task by calling tasks.task.add with detailed JSON payload.
  • Updating user information via user.update endpoint.

Properties

Name Meaning
Authentication Method of authenticating API requests. Options: OAuth2 (recommended for production), Webhook (simpler but less secure), API Key authentication.
Method The Bitrix24 REST API endpoint to call, specified without domain or authentication parts. Examples: crm.lead.list, user.get, tasks.task.list.
Body JSON object representing the request body to send with the API call. Example: {"FIELDS": {"TITLE": "New Lead", "NAME": "John"}}.
Access Token Optional override for the access token to use instead of the one from credentials.
Debug Mode Enable debug mode to log detailed request and response information for troubleshooting purposes.

Output

The node outputs the JSON response returned by the Bitrix24 API call in the json field of each item. This output reflects the structure of the Bitrix24 API response for the called endpoint.

If debug mode is enabled, additional details about the request and response may be included in the output or logs.

The node does not explicitly handle binary data output.

Dependencies

  • Requires valid Bitrix24 authentication credentials configured in n8n, supporting OAuth2, webhook URL, or API key methods.
  • Network access to Bitrix24 REST API endpoints.
  • Optionally requires an access token if overriding default credentials.
  • No external libraries beyond those bundled with the node are required.

Troubleshooting

  • Invalid Authentication: Errors related to authentication failure usually indicate incorrect or expired credentials. Verify the selected authentication method and refresh tokens if necessary.
  • Malformed JSON Body: Providing invalid JSON in the Body property will cause API errors. Ensure the JSON syntax is correct and matches the expected API schema.
  • Incorrect Endpoint: Specifying an invalid or unsupported API method name will result in API errors. Double-check the endpoint string for typos or unsupported calls.
  • Rate Limits: Bitrix24 enforces API rate limits; excessive calls may lead to temporary blocking. Implement retries or delays if encountering rate limit errors.
  • Debug Mode: Enable debug mode to get detailed logs of requests and responses, which helps diagnose issues with API calls.

Links and References

Discussion