Bitrix24 icon

Bitrix24

Work with Bitrix24 API

Actions25

Overview

This node integrates with the Bitrix24 CRM system to manage Lead records. Specifically, the "Create" operation for the Lead resource allows users to add new leads into their Bitrix24 account by specifying lead fields either through a form interface or by providing raw JSON data.

Common scenarios where this node is beneficial include:

  • Automating lead capture from web forms or other sources directly into Bitrix24.
  • Integrating external marketing tools or databases to push new lead information into Bitrix24.
  • Streamlining sales workflows by programmatically creating leads based on triggers in other systems.

Practical example:

  • A marketing automation workflow captures a visitor's contact details and uses this node to create a new lead in Bitrix24 with those details, enabling immediate follow-up by the sales team.

Properties

Name Meaning
Input Format Choose how to provide lead field data:
- Form: Use a structured form input for each field.
- JSON: Provide all fields as a JSON object string.
Fields (JSON) When using JSON input format, specify the lead fields as a JSON object string. Example:
json { "TITLE": "New Lead", "STATUS_ID": "NEW" }
Fields When using Form input format, add one or more fields to set on the lead. Each field includes:
- Field Name: The name of the lead field to set.
- Communication Type (only for certain contact fields): Type of contact data such as Work, Mobile, Home, Fax, Telegram, WhatsApp, Viber, Facebook, Skype, Other.
- Field Value: The value to assign to the field. For enumeration fields, select from available options; otherwise, enter a string value.

Output

The node outputs an array of JSON objects representing the response from Bitrix24 after attempting to create the lead(s). Each object typically contains:

  • The result of the creation request, including the ID of the newly created lead and any additional metadata returned by Bitrix24.
  • In case of errors, an error message describing what went wrong.

No binary data output is produced by this node.

Dependencies

  • Requires a valid Bitrix24 API authentication token configured in n8n credentials.
  • Needs the Bitrix24 webhook URL to access the CRM API endpoints.
  • Uses HTTP POST requests to Bitrix24 REST API endpoints for lead creation.
  • Environment variable N8N_DEFAULT_LANGUAGE may be set dynamically based on credential language preference (defaulting to Russian if not specified).

Troubleshooting

  • Missing Credentials or Webhook URL: The node will throw errors if the API credentials or webhook URL are not provided or invalid. Ensure that the Bitrix24 API key and webhook URL are correctly configured in n8n.
  • Invalid JSON in Fields (JSON): If using JSON input format, malformed JSON will cause parsing errors. Validate JSON syntax before running the node.
  • Field Names Not Recognized: Using incorrect or unsupported field names can cause API errors. Use the "Fields" dropdown which loads available fields dynamically from Bitrix24 to avoid typos.
  • Enumeration Field Values: For fields with enumerated values, selecting an invalid option or entering free text instead of choosing from the list may cause errors.
  • API Rate Limits or Network Issues: Network failures or Bitrix24 API rate limits can cause request failures. Retry or check network connectivity and API usage quotas.
  • Error Messages: Errors returned from Bitrix24 are passed through in the output. Review these messages for specific issues like permission problems or invalid data.

Links and References

Discussion