OpenProjectInstall

Overview

This node operation fetches unread notifications from the OpenProject system. It allows users to retrieve notifications that have not yet been marked as read, filtered by various criteria such as project, reason for notification, or related resource. This is useful in scenarios where you want to monitor new activity or updates relevant to a user without manually checking the OpenProject interface.

Practical examples include:

• Automatically fetching all unread notifications where the user was mentioned.
• Retrieving unread notifications related to a specific project to trigger follow-up actions.
• Filtering notifications by resource type and ID to track changes on particular work items.

Properties

Example of a default filter value:

[
  {
    "reason": {
      "operator": "=",
      "values": ["mentioned"]
    }
  }
]

Output

The node outputs an array of JSON objects representing unread notifications matching the specified filters. Each notification object typically contains details such as its ID, associated project, reason for notification, related resource information, and other metadata provided by the OpenProject API.

No binary data output is produced by this operation.

Dependencies

• Requires an active connection to an OpenProject instance via an API key credential.
• The node depends on the OpenProject REST API, specifically the endpoint for querying notifications with filter parameters.
• Proper configuration of the base URL and authentication credentials in n8n is necessary.

Troubleshooting

• Common issues:

  • Incorrect or malformed JSON in the Filters property can cause query failures.
  • Using unsupported filter fields may result in empty responses or errors.
  • Network connectivity problems or invalid API credentials will prevent successful requests.

• Error messages:

  • "Invalid filter format" — Ensure the Filters JSON is correctly structured according to OpenProject's query syntax.
  • "Authentication failed" — Verify that the API key credential is valid and has sufficient permissions.
  • "Resource not found" — Check that the specified project or resource IDs exist and are accessible.

Links and References

• OpenProject API Documentation - Queries Endpoint
• OpenProject Notifications API (general reference)