OpenProject

Interact with OpenProject via API

Actions199

Collections Actions
- View Aggregated Result
Forms Actions
- Show Or Validate Form
Actions Capabilities Actions
- List Actions
- View Action
- List Capabilities
- View Capabilities
Activities Actions
- View Activity
- Update Activity
Attachments Actions
- Delete Attachment
- View Attachment
- List Attachments By Meeting
- Add Attachment To Meeting
- List Attachments By Post
- Add Attachment To Post
- List Attachments By Wiki Page
- Add Attachment To Wiki Page
- List Work Package Attachments
- Create Work Package Attachment
Budgets Actions
- View Budget
- View Budgets Of A Project
Categories Actions
- View Category
- List Categories Of A Project
Custom Actions Actions
- Get Custom Action
- Execute Custom Action
Custom Options Actions
- View Custom Option
Documents Actions
- List Documents
- View Document
File Links Actions
- View File Link
- Delete File Link
- Open File Link
- Download File Link
- List Project Storages
- Get Project Storage
- Open Project Storage
- Create Storage
- Get Storage
- Update Storage
- Delete Storage
- Get Storage Files
- Prepare Storage File Upload
- Create Storage Folder
- Create Storage Oauth Credentials
- Open Storage
- Create Work Package File Link
- List Work Package File Links
Grids Actions
- List Grids
- Create Grid
- Get Grid
- Update Grid
- Grid Update Form
Groups Actions
- List Groups
- Create Group
- Delete Group
- Get Group
- Update Group
Help Texts Actions
- Get Help Text
Memberships Actions
- List Memberships
- Create Membership
- Form Create Membership
- Delete Membership
- Get Membership
- Update Membership
- Form Update Membership
Query Filter Instance Schema Actions
- List Query Filter Instance Schemas For Project
- View Query Filter Instance Schema
News Actions
- List News
- Create News
- View News
- Update News
- Delete News
Notifications Actions
- List Notifications
- Read Notifications
- Unread Notifications
- View Notification
- View Notification Detail
- Read Notification
- Unread Notification
O Auth 2 Actions
- Get Oauth Application
- Get Oauth Client Credentials
Posts Actions
- View Post
Principals Actions
- List Placeholder Users
- Create Placeholder User
- Delete Placeholder User
- View Placeholder User
- Update Placeholder User
- List Principals
- List Users
- Create User
- Delete User
- View User
- Update User
Priorities Actions
- View Priority
Query Columns Actions
- View Query Column
Query Filters Actions
- View Query Filter
Query Operators Actions
- View Query Operator
Query Sort Bys Actions
- View Query Sort By
Relations Actions
- List Relations
- Get Relation
- Delete Relation
- Update Relation
- Create Relation
Previewing Actions
- Preview Markdown Document
Revisions Actions
- View Revision
Roles Actions
- List Roles
- View Role
Time Entries Actions
- List Time Entries
- Create Time Entry
- Time Entry Update Form
- Delete Time Entry
- Get Time Entry
- Update Time Entry
Time Entry Activities Actions
- Get Time Entries Activity
Types Actions
- List Types Available In A Project
- View Type
User Preferences Actions
- Update User Preferences
Wiki Pages Actions
- View Wiki Page
Work Schedule Actions
- List Non Working Days
- Create Non Working Day
- View Non Working Day
- Update Non Working Day
- Delete Non Working Day
- Update Week Days
- View Week Day
- Update Week Day
- List Days
- View Day
Meetings Actions
- View Meeting
Values Property Actions
- View Notification Detail
- View Values Schema
Projects Actions
- List Projects
- Create Project
- Delete Project
- View Project
- Update Project
- Project Update Form
- Create Project Copy
- Project Copy Form
- View Project Status
- List Available Parent Project Candidates
- List Projects With Version
Queries Actions
- View Default Query For Project
- View Schema For Project Queries
- List Queries
- Create Query
- View Default Query
- Query Create Form
- Delete Query
- View Query
- Edit Query
- Query Update Form
- Star Query
- Unstar Query
Users Actions
- Update User
- List Users
- Create User
- Delete User
- View User
- User Update Form
- Unlock User
- Lock User
Statuses Actions
- Get Status
Versions Actions
- List Versions Available In A Project
- List Versions
- Delete Version
- View Version
- Update Version
- Version Update Form
Work Packages Actions
- Get Project Work Package Collection
- Create Project Work Package
- List Work Package File Links
- Form Create Work Package In Project
- Project Available Assignees
- List Work Packages
- Create Work Package
- Form Create Work Package
- List Work Package Schemas
- View Work Package Schema
- Delete Work Package
- View Work Package
- Update Work Package
- List Work Package Activities
- Comment Work Package
- Work Package Available Assignees
- Available Projects For Work Package
- List Available Relation Candidates
- Available Watchers
- Create Work Package File Link
- Form Edit Work Package
- Revisions
- Reminders
- List Watchers
- Add Watcher
- Remove Watcher
Views Actions
- List Views
- View View
- Create Views
- Get Custom Field Items
- Get Custom Field Item
- Get Custom Field Item Branch

Overview

This node operation, Form Create Membership under the Memberships resource, allows users to create a membership entry in OpenProject by submitting a structured JSON form. It is useful when you want to programmatically assign roles or link users (principals) to projects or work packages within OpenProject.

Typical use cases include:

Automating project team assignments.
Creating memberships with specific roles for users on projects or work packages.
Integrating membership creation into larger workflows that manage project resources and permissions.

For example, you might use this node to add a user as a member of a project with a defined role, triggering notifications about their new membership.

Properties

Name	Meaning
_links	JSON object defining links related to the membership creation. Includes: - `principal`: The user or entity to be linked, with an API endpoint (`href`) and HTTP method. - `roles`: An array specifying roles assigned to the principal. - `project`: The project or work package context for the membership.
_meta	JSON object containing metadata for the request. Includes: - `notificationMessage`: A message formatted in markdown, raw text, and HTML to notify about the membership creation. - `sendNotification`: Boolean flag indicating whether to send a notification upon membership creation.

Output

The node outputs JSON data representing the response from the OpenProject API after attempting to create the membership. This typically includes details of the newly created membership such as identifiers, linked principal, roles, and project information.

No binary data output is involved in this operation.

Dependencies

Requires an active connection to an OpenProject instance via its REST 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 JSON in _links or _meta properties: Since these fields expect valid JSON, malformed input will cause errors. Ensure JSON syntax is correct before running the node.
Authorization errors: If the API key or token is missing or invalid, the node will fail to authenticate. Verify credentials are correctly set up.
API endpoint errors: Incorrect URLs or HTTP methods in the _links property can lead to failed requests. Confirm the href and method values match OpenProject API specifications.
Notification failures: If sendNotification is true but notification settings are misconfigured in OpenProject, notifications may not be sent even though the membership is created.

Links and References

OpenProject API Documentation
OpenProject Memberships API
n8n Documentation on HTTP Request Nodes (for understanding how JSON bodies are sent)

OpenProjectInstall