Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform
Join our community

Actions290

Overview

This node interacts with the Bitrix24 platform, specifically focusing on managing notifications. The "Notify" resource with the "Mark as Read" operation allows users to mark a specific notification as read within their Bitrix24 account. This is useful for automating notification management workflows, such as acknowledging alerts or clearing notification badges programmatically.

Practical examples include:

  • Automatically marking notifications as read after processing them in a workflow.
  • Integrating with other systems to update notification statuses based on external events.
  • Managing user notification states in bulk or selectively via automation.

Properties

Name Meaning
Authentication Method of authenticating with Bitrix24: OAuth2 (recommended), Webhook (simpler), or API Key.
Notification ID The unique identifier of the notification to mark as read.
Options Additional optional settings for notifications, including:
- Attachments JSON array specifying attachments related to the notification.
- URL Preview Boolean indicating whether to show URL previews in the notification.
- Sound Boolean indicating whether to play a sound when the notification is received.
- Push Boolean indicating whether to send a push notification.
- Email Boolean indicating whether to send an email notification.
- Buttons JSON array defining interactive buttons for the notification.
- Confirm Text Text label for a confirm button in the notification.
- Decline Text Text label for a decline button in the notification.
- Offset Numeric offset used when retrieving notifications (pagination).
- Filter JSON object defining filter criteria for notifications.
- Order JSON object defining sort order for notifications.

Output

The node outputs an array of items where each item contains a json property representing the response from Bitrix24 after marking the notification as read. The exact structure depends on the Bitrix24 API response but typically includes confirmation of the action and possibly updated notification details.

If an error occurs and the node is configured to continue on failure, the output will contain an item with an error field describing the issue, along with the resource name and a timestamp.

No binary data output is indicated.

Dependencies

  • Requires authentication with Bitrix24 via one of the supported methods: OAuth2, webhook URL, or API key.
  • The node relies on Bitrix24's API endpoints to perform operations.
  • Proper credentials must be configured in n8n for the chosen authentication method.

Troubleshooting

  • Common Issues:

    • Invalid or expired authentication credentials can cause authorization failures.
    • Incorrect or missing Notification ID will result in errors as the API cannot identify which notification to mark.
    • Improperly formatted JSON in options like attachments or buttons may cause request failures.

  • Error Messages:

    • Errors returned by the Bitrix24 API will be surfaced in the node's output if "Continue On Fail" is enabled.
    • Typical messages might include "Notification not found" or "Unauthorized".

  • Resolutions:

    • Verify that the authentication credentials are valid and have necessary permissions.
    • Ensure the Notification ID is correct and corresponds to an existing notification.
    • Validate JSON formatting in any option fields before execution.

Links and References

Discussion