Overview
This node acts as a trigger that starts an n8n workflow when specific events occur in the Plane project management system. It listens for webhook calls from Plane and processes incoming event data such as issues, issue comments, cycles, modules, and projects.
Common scenarios where this node is beneficial include:
- Automating notifications or actions when new issues are created or updated.
- Tracking comments added to issues for collaboration workflows.
- Responding to changes in project cycles or modules.
- Integrating Plane events with other tools like Slack, email, or databases.
For example, you could use this node to automatically send a message to a team chat whenever a new issue is created or to update a dashboard when a project cycle status changes.
Properties
| Name | Meaning |
|---|---|
| Events | The types of Plane events to listen for. Options: Cycle, Issue, Issue Comment, Module, Project. You can select multiple event types to trigger the workflow on any of them. |
| Webhook Secret | A signature secret key used to verify the authenticity of incoming webhook requests. Must match the secret configured in Plane. If left empty, signature verification is skipped (less secure). |
| Plane 基础 URL | The base URL of your Plane instance, used to generate links to issues and projects. Default is https://planes.inner.youdao.com. |
| 说明 (Notice) | Instructions reminding users to manually configure the webhook in Plane’s backend by providing the n8n webhook URL and secret, selecting desired event types, and saving the settings. |
Output
The node outputs JSON data representing the received Plane event. The output includes:
event: The type of event received (e.g., "issue", "issue_comment").delivery: A unique delivery identifier or timestamp.headers: HTTP headers from the webhook request.body: The full webhook payload sent by Plane.formatted_markdown: A human-readable markdown summary of the event, including actor, action, and relevant links.- Additional fields such as
issueKey,issueLink, andproject_identifierwhen applicable, providing direct references to Plane issues and projects.
No binary data is output by this node.
Dependencies
- Requires an API key credential for Plane to fetch additional details about projects and issues when needed.
- The user must manually set up the webhook in the Plane backend, specifying the n8n webhook URL and secret.
- Uses the
cryptomodule for HMAC SHA256 signature verification of incoming webhook requests. - Uses the
axioslibrary for making HTTP requests to Plane’s API to enrich event data.
Troubleshooting
- Webhook Signature Verification Failed: If the webhook secret in n8n does not match the one configured in Plane, the node will reject the request. Ensure both secrets are identical.
- Missing Workspace Slug in Credentials: The node requires workspace information from credentials to make API requests. Verify that the API key and workspace slug are correctly configured.
- Error Fetching Project or Issue Details: Network issues or incorrect API credentials can cause failures when enriching event data. Check API key validity and network connectivity.
- No Events Triggered: Confirm that the Plane webhook is properly configured to send the selected event types to the correct n8n webhook URL.
- Malformed Event Data: If Plane sends unexpected data formats, the node may fail to format the markdown summary. Review Plane webhook payloads for consistency.
Links and References
- Plane Official Documentation (for webhook setup and API details)
- n8n Webhook Documentation
- HMAC SHA256 Signature Verification