OpenProject icon

OpenProject

Consume OpenProject API

Overview

This node integrates with the OpenProject API to manage various resources such as projects, users, work packages, time entries, versions, and others. Specifically for the Project - Create operation, it allows users to create a new project in OpenProject by specifying essential details like the project name and identifier, along with optional additional fields.

Common scenarios where this node is beneficial include:

  • Automating project creation workflows when onboarding new clients or teams.
  • Integrating project management into broader automation pipelines, e.g., creating projects based on CRM triggers.
  • Bulk project creation from external data sources.

Example: Automatically create a new project named "Website Redesign" with identifier "web-redesign" and set its status to "Active" whenever a new client signs up.

Properties

Name Meaning
Project Name The name of the project to be created.
Project Identifier A unique identifier for the project.
Additional Fields Optional extra information about the project, including:
- Description: A textual description of the project.
- Status: The current status of the project. Options are: Active, Archived, On Track.

Output

The node outputs an array of JSON objects, each representing the response from the OpenProject API for the created project resource. The JSON structure corresponds directly to the API's project representation, typically including fields such as project ID, name, identifier, description, status, and other metadata returned by OpenProject.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the OpenProject API.
  • Needs an API key credential configured in n8n for authentication.
  • The base URL of the OpenProject instance must be provided in the credentials.
  • Uses HTTP Basic Authentication with the API key encoded in Base64.

Troubleshooting

  • Common issues:

    • Invalid or missing API key credential will cause authentication failures.
    • Incorrect base URL or network connectivity issues can prevent API calls.
    • Providing duplicate or invalid project identifiers may result in API errors.
    • Missing required fields (Project Name, Project Identifier) will cause validation errors.
  • Error messages:

    • Errors returned by the OpenProject API are surfaced with their message, e.g., "OpenProject error response: <message>".
    • If the API returns no detailed message, the node throws a generic error with the underlying message.
  • Resolution tips:

    • Verify that the API key and base URL are correctly configured.
    • Ensure all required fields are filled out properly.
    • Check the OpenProject API documentation for valid values and constraints on project identifiers and statuses.
    • Use the "Continue on Fail" option in n8n to handle errors gracefully during batch operations.

Links and References

Discussion