iTwin Issues icon

iTwin Issues

iTwin Issues API for issue management, form definitions, attachments, and comments

Actions27

Overview

This node integrates with the iTwin Issues API to add comments to existing issues within an iTwin project. It is useful for automating issue tracking workflows by programmatically appending comments, including notifications to project members via email mentions. For example, a user can automatically add status updates or feedback to issues as part of a CI/CD pipeline or project management automation.

Properties

Name Meaning
ID The unique identifier of the issue to which the comment will be added.
Text The content of the comment to add. If the text includes a project member's email preceded by @ (e.g., @john.doe@example.com), that user will receive an email notification about the comment.
Options Additional optional settings:
- Custom Payload: Allows overriding the default request body with a custom JSON payload. Useful for advanced use cases where the standard comment text is insufficient or needs customization.

Output

The node outputs JSON data representing the response from the iTwin Issues API after adding the comment. This typically includes details of the newly created comment such as its ID, content, author, timestamps, and any metadata returned by the API.

If the "Custom Payload" option is used, the output corresponds to the API response based on the custom JSON sent.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the iTwin platform via an OAuth2 API credential.
  • The node depends on the iTwin Issues REST API endpoint.
  • Proper configuration of the OAuth2 credentials in n8n is necessary to authenticate requests.
  • Network access to https://api.bentley.com is required.

Troubleshooting

  • Common issues:

    • Invalid or missing issue ID: Ensure the "ID" property correctly references an existing issue.
    • Authentication failures: Verify that the OAuth2 credentials are valid and have sufficient permissions.
    • Malformed comment text or JSON payload: When using the custom payload option, ensure the JSON is well-formed.
    • API rate limits or network errors: Check connectivity and API usage quotas.

  • Error messages:

    • "Unsupported operation": Indicates the node was configured with an unsupported operation; verify the selected operation is "Add comment to issue".
    • API errors returned from the iTwin platform will be passed through; check the error message for details such as permission denied or invalid parameters.
    • JSON parsing errors when using custom payloads suggest invalid JSON syntax.

Links and References

Discussion