OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node operation retrieves the list of users who are available to be watchers on a specific work package in OpenProject. Watchers are users who receive notifications about changes or updates to the work package, helping teams stay informed about relevant tasks or issues.

Common scenarios for this node include:

  • Automatically fetching potential watchers to assign them to a work package.
  • Displaying available watchers in a user interface for selection.
  • Integrating with notification systems to manage watchers dynamically.

For example, a project manager might use this node to get all users eligible to watch a particular task and then assign watchers based on team roles or availability.

Properties

Name Meaning
Id The unique identifier of the work package for which to retrieve available watchers. This is a required numeric input.

Output

The node outputs a JSON array containing the details of users who can be assigned as watchers to the specified work package. Each item typically includes user information such as user ID, name, and possibly email or other contact details depending on the API response.

No binary data output is expected from this operation.

Dependencies

  • Requires an active connection to an OpenProject instance via its API.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The base URL of the OpenProject server must be set in the node's credential configuration.

Troubleshooting

  • Invalid Work Package ID: If the provided work package ID does not exist or is incorrect, the node may return an error or empty result. Verify the ID before running the node.
  • Authentication Errors: Missing or invalid API credentials will cause authorization failures. Ensure that the API key/token is correctly configured and has sufficient permissions.
  • Network Issues: Connectivity problems with the OpenProject server will prevent data retrieval. Check network access and server status.
  • API Rate Limits: Excessive requests might be throttled by the OpenProject API. Implement retry logic or reduce request frequency if needed.

Links and References

Discussion