OpenProject icon

OpenProject

Interact with OpenProject via API
Join our community

Actions199

Overview

This node operation "List Notifications" for the "Notifications" resource interacts with an OpenProject API to retrieve a paginated list of notifications. It allows users to query notifications with various filtering, sorting, and grouping options. This is useful in scenarios where you want to monitor or process project-related notifications programmatically, such as fetching unread notifications, filtering by project or reason, or sorting them by different criteria.

Practical examples include:

  • Automatically retrieving all unread notifications to alert a user.
  • Fetching notifications related to a specific project for reporting.
  • Sorting notifications by their reason or read status to prioritize processing.

Properties

Name Meaning
Offset Page number inside the requested collection (pagination offset).
Page Size Number of elements to display per page (pagination limit).
Sort By JSON string specifying sort criteria. Supported sorts: id (primary key), reason (notification reason), readIAN (read status). Example format: [["reason", "asc"]].
Group By String specifying group-by criteria. Supported values: reason (group by notification reason), project (group by associated project).
Filters JSON string specifying filter conditions. Supported filters include: id (primary key), project (project the notification was created in), readIAN (read status), reason (notification reason), resourceId, and resourceType. Example default filters unread notifications.

Output

The output contains a JSON array of notification objects retrieved from the OpenProject API according to the specified query parameters. Each notification object typically includes details such as its ID, reason, read status, associated project, and related resource information.

If binary data were involved (not indicated here), it would be summarized accordingly, but this operation deals solely with JSON notification data.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • The node uses the base URL provided in the credentials to connect to the OpenProject instance.
  • No additional external dependencies beyond the OpenProject API and n8n's HTTP request capabilities.

Troubleshooting

  • Common issues:
    • Incorrect or missing API credentials will cause authentication failures.
    • Malformed JSON strings in Sort By or Filters properties can lead to API errors.
    • Pagination parameters (Offset, Page Size) set outside valid ranges may result in empty responses or errors.
  • Error messages:
    • Authentication errors usually indicate invalid or expired API tokens; verify and update credentials.
    • API validation errors on filters or sorting mean the JSON format or field names are incorrect; ensure they match the documented API schema.
    • Network or connectivity errors suggest issues reaching the OpenProject server; check URL and network access.

Links and References

Discussion