Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform
Join our community

Actions290

Overview

This node integrates with the Bitrix24 platform, specifically providing functionality to retrieve notification schemas under the "Notify" resource with the "Get Schema" operation. It allows users to fetch notification settings and configurations such as attachments, URL previews, sounds, push notifications, emails, interactive buttons, and filtering options.

Common scenarios where this node is beneficial include:

  • Automating retrieval of notification preferences or schemas from Bitrix24.
  • Integrating Bitrix24 notifications into workflows for monitoring or alerting purposes.
  • Customizing notification handling based on user-defined filters and options.

Practical example:

  • A workflow that periodically fetches notification schemas to adjust how notifications are displayed or processed in an external system.
  • Using the node to get notification settings before sending custom alerts or messages through Bitrix24.

Properties

Name Meaning
Authentication Method of authenticating with Bitrix24. Options: OAuth2 (recommended for production), Webhook (simpler but less secure), API Key.
Options Collection of optional parameters to customize the notification schema retrieval:
- Attachments Attachments in JSON format to include with notifications.
- URL Preview Boolean indicating whether to show URL preview in notifications.
- Sound Boolean indicating whether to play a notification sound.
- Push Boolean indicating whether to send push notifications.
- Email Boolean indicating whether to send email notifications.
- Buttons Interactive buttons for the notification, provided in JSON format.
- Confirm Text Text label for the confirm button in interactive notifications.
- Decline Text Text label for the decline button in interactive notifications.
- Offset Numeric offset for paginating or skipping notifications when retrieving them.
- Filter JSON object specifying filter criteria to narrow down which notifications to retrieve.
- Order JSON object specifying sort order for the retrieved notifications.

Output

The node outputs an array of items, each containing a json field representing the response from Bitrix24's notification schema endpoint. The structure typically includes notification details according to the specified options and filters.

If errors occur and the node is configured to continue on failure, the output will contain an error object with fields:

  • error: Error message string.
  • resource: The resource name ("notify").
  • timestamp: ISO timestamp of the error occurrence.

The node does not explicitly handle binary data output.

Dependencies

  • Requires authentication credentials for Bitrix24, which can be provided via OAuth2, webhook URL, or API key.
  • Uses internal helper functions to make API calls to Bitrix24 endpoints.
  • No additional external services beyond Bitrix24 API are required.
  • Proper configuration of authentication credentials in n8n is necessary.

Troubleshooting

  • Common issues:

    • Authentication failures due to incorrect or expired credentials.
    • Malformed JSON in options like attachments, buttons, filter, or order causing API call failures.
    • Network connectivity issues preventing access to Bitrix24 API.
    • Incorrect usage of offset or filter parameters leading to empty or unexpected results.

  • Error messages:

    • Errors thrown by the Bitrix24 API will be surfaced in the node output if "Continue On Fail" is enabled.
    • Typical error messages may include authentication errors, invalid parameter formats, or API rate limits.

  • Resolutions:

    • Verify and update authentication credentials.
    • Ensure JSON inputs are valid and correctly formatted.
    • Check network connectivity and Bitrix24 service status.
    • Adjust filter and pagination parameters to valid values.

Links and References

Discussion