OpenProjectInstall

Overview

This node allows you to execute a custom action within the "Custom Actions" resource of an external system (likely OpenProject, based on context). It is designed to trigger predefined custom actions by their identifier, optionally sending additional data such as links and lock version information. This can be useful in workflows where you want to automate specific operations or business logic encapsulated as custom actions in the target system.

Practical examples include:

• Triggering a workflow step that updates related work packages.
• Executing a custom validation or state change defined as a custom action.
• Automating integration points where custom actions represent API endpoints for specialized tasks.

Properties

Output

The node outputs the JSON response returned from executing the custom action. This typically contains the result or status of the executed action, including any updated data or confirmation messages.

If the node supports binary data output, it would represent files or attachments related to the custom action execution, but this is not indicated in the provided code or properties.

Dependencies

• Requires an API key credential to authenticate requests against the external system's API.
• Needs the base URL of the API endpoint configured in credentials.
• Depends on the external system supporting custom actions accessible via its REST API.

Troubleshooting

• Common issues:

  • Invalid or missing custom action ID will cause the API call to fail.
  • Incorrect or expired API credentials will lead to authentication errors.
  • Sending malformed JSON in the "Links" property may cause request parsing errors.
  • Using an outdated lock version might result in conflict errors due to concurrent modifications.

• Error messages and resolutions:

  • "Unauthorized" or "Authentication failed": Verify API credentials and permissions.
  • "Not Found" or "Custom action does not exist": Check that the provided Id corresponds to an existing custom action.
  • "Conflict" or "Lock version mismatch": Refresh the lock version from the latest resource state before retrying.
  • "Bad Request": Ensure JSON syntax in the Links property is valid and all required fields are correctly set.

Links and References

• OpenProject API Documentation
• n8n Documentation on Creating Custom Nodes