Actions31
- Company Actions
- Contact Actions
- Deal Actions
- Item Actions
- Lead Actions
- User Custom Method Actions
Overview
This node allows users to interact with the Bitrix24 REST API by calling any custom API method. It is designed for scenarios where predefined resource-operation pairs do not cover all needed API endpoints or when advanced/customized API calls are required. Users can specify the exact Bitrix24 API method name and provide parameters either as individual fields or as raw JSON data.
Practical examples include:
- Adding or updating CRM contacts with specific filters or fields not covered by standard operations.
- Executing complex queries or commands on Bitrix24 entities using custom API methods.
- Integrating unique Bitrix24 features or third-party extensions that require direct API access.
Properties
| Name | Meaning |
|---|---|
| Authentication | Choose the authentication method: - OAuth2 - Webhook |
| API Method | The Bitrix24 REST API method to call, e.g., crm.contact.add. Refer to Bitrix24 API documentation for valid method names. (Required) |
| Input Type | How to provide input parameters: - Using Fields: Fill key-value pairs individually - Using JSON: Provide complete raw JSON data |
| Parameters | When "Using Fields" is selected, add multiple key-value pairs as request parameters. Supports dot notation for nested fields, e.g., filter.STAGE_ID |
| JSON Data | When "Using JSON" is selected, provide the entire request body as raw JSON. |
Output
The node outputs the response from the Bitrix24 API call in the json field of each item. This typically contains the result of the invoked API method, which may vary depending on the method called. For example, it could be an object representing a created or updated entity, a list of records, or status information.
If the API returns binary data (not typical for Bitrix24 REST API), it would be included in the binary output, but this node primarily deals with JSON responses.
Dependencies
- Requires a valid Bitrix24 API authentication credential, either via OAuth2 or Webhook.
- The user must have appropriate permissions in Bitrix24 to execute the specified API methods.
- No additional external dependencies beyond the Bitrix24 API and n8n's HTTP request capabilities.
Troubleshooting
- Invalid API Method: If the API method name is incorrect or misspelled, the Bitrix24 API will return an error. Verify the method name against the official Bitrix24 REST API documentation.
- Authentication Errors: Ensure the selected authentication method is correctly configured and authorized. OAuth2 tokens may expire and need refreshing.
- Parameter Formatting Issues: When using fields, nested parameters must use dot notation correctly. Incorrect parameter names or formats can cause API errors.
- JSON Syntax Errors: When providing raw JSON, ensure the JSON is well-formed. Invalid JSON will cause the node to fail before sending the request.
- API Rate Limits: Bitrix24 enforces rate limits; excessive requests may lead to temporary blocking. Implement retries or delays if necessary.
Links and References
This summary is based solely on static analysis of the provided source code and property definitions.