OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node allows users to add comments to existing work packages in OpenProject, a project management system. It is useful for teams who want to programmatically update work packages with additional information or feedback without manually accessing the OpenProject interface. For example, after an automated test run, a comment can be added to a related work package describing the test results.

Properties

Name Meaning
Id The unique identifier of the work package to which the comment will be added. This is a required numeric field.
Notify A boolean flag indicating whether change notifications (such as emails) should be sent to all users interested in the work package (e.g., watchers, author, assignee). Defaults to false.
Comment A JSON object representing the comment content to be added to the work package. This must be provided as a valid JSON string and will be parsed before sending in the request body.

Output

The node outputs the response from the OpenProject API after adding the comment to the specified work package. The output is structured as JSON data reflecting the updated state or confirmation of the comment addition. There is no binary data output.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • The base URL of the OpenProject instance must be configured in the node credentials.
  • The node uses the OpenProject REST API endpoint for work packages to post comments.

Troubleshooting

  • Invalid Work Package ID: If the provided work package ID does not exist, the API will return an error. Verify that the ID is correct and that the user has permission to access it.
  • Malformed Comment JSON: The comment property must be valid JSON. Invalid JSON will cause parsing errors before the request is sent.
  • Notification Issues: Setting the notify flag to true sends email notifications to all interested users. If notifications are not received, check the OpenProject email configuration.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to modify work packages.

Links and References

Discussion