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 interacts with the OpenProject API to read notifications based on specified filter criteria. It is useful for workflows that need to retrieve and process user notifications from OpenProject, such as alerts about mentions, assignments, or updates related to projects or resources.

Practical examples include:

Automatically fetching all notifications where a user was mentioned to trigger follow-up actions.
Filtering notifications by project to monitor activity in specific projects.
Retrieving notifications related to particular resource types or IDs for detailed tracking.

Properties

Name Meaning

Filters JSON string specifying filter conditions for reading notifications. Supports filtering by: id (primary key), project (project of notification), reason (e.g., "mentioned", "assigned"), resourceId (ID of related resource), and resourceType (type of related resource). The filters use the same format as OpenProject query filters. Default example filters notifications where the reason equals "mentioned".

Name	Meaning
Filters	JSON string specifying filter conditions for reading notifications. Supports filtering by: `id` (primary key), `project` (project of notification), `reason` (e.g., "mentioned", "assigned"), `resourceId` (ID of related resource), and `resourceType` (type of related resource). The filters use the same format as OpenProject query filters. Default example filters notifications where the reason equals "mentioned".

Output

The node outputs JSON data representing the notifications retrieved from OpenProject according to the applied filters. Each notification object typically includes details such as its ID, associated project, reason for notification, related resource information, and timestamps.

No binary data output is indicated.

Dependencies

Requires an API key credential for authenticating with the OpenProject API.
Needs the base URL of the OpenProject instance configured in the node credentials.
Depends on the OpenProject REST API being accessible and properly configured to allow querying notifications.

Troubleshooting

Common issues:
- Invalid or malformed JSON in the Filters property can cause request failures.
- Incorrect or missing API credentials will result in authentication errors.
- Using unsupported filter fields may lead to empty results or API errors.
- Network connectivity problems to the OpenProject server will prevent data retrieval.
Error messages and resolutions:
- Authentication failed: Verify the API key and base URL are correct and have sufficient permissions.
- Invalid filter format: Ensure the Filters JSON matches the expected structure and supported fields.
- No notifications found: Check filter criteria; try broadening filters or removing them to confirm data presence.

Links and References

OpenProject API Queries Documentation
OpenProject Notifications API Reference (general reference)

OpenProjectInstall