OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node allows users to create news entries in an external system via its API. It is useful for automating the publication of news articles or announcements within a project management or content platform that supports such news items. Typical use cases include automatically posting updates, alerts, or newsletters based on triggers from other workflows.

For example, you could use this node to:

  • Publish a new company announcement when a certain event occurs.
  • Automatically generate news posts summarizing recent project activities.
  • Create news items from form submissions or external data feeds.

Properties

Name Meaning
Title The headline of the news article.
Summary A short summary providing a brief overview of the news content.
Description The main body of the news with all details, formatted as JSON supporting markdown/html.
Links JSON object defining related links or references associated with the news item.

Output

The node outputs JSON data representing the created news item as returned by the API. This typically includes fields such as the news ID, title, summary, description, creation timestamps, and any linked resources. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating with the external service.
  • Needs the base URL of the target API configured in credentials.
  • Depends on the external system's API being available and accessible.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Malformed JSON in the Description or Links properties may result in request errors.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:
    • Authentication errors usually indicate invalid or expired API keys; verify and update credentials.
    • Validation errors from the API often mean required fields are missing or incorrectly formatted; ensure Title and Description are properly set.
    • Timeout or connection errors suggest network issues; check connectivity and API endpoint availability.

Links and References

  • Refer to the external system’s API documentation for detailed information on the News resource and its fields.
  • Markdown formatting guide for composing the Description property content.

Discussion