Skip to content

[feature]: Enhancing issue_comment webhook payload with issue context #8883

@4b75726169736859

Description

@4b75726169736859

Is there an existing issue for this?

  • I have searched the existing issues

Summary

Hi Plane team,

I've been working on integrating Plane with our internal messaging tools (via webhooks) and I've run into a small limitation that I think could be easily improved.

The issue:
Currently, when an issue_comment event is triggered, the payload only provides the UUIDs for the issue and the project. If I want to display a useful notification (like "User commented on Task Name"), I have to trigger a separate API call just to fetch the issue's title and sequence ID.

Current payload looks like this:

"data": {
    "comment_html": "<p>...</p>",
    "issue": "728e31d5-9921-486a-991b-76ad7c6aa841",
    "project": "d54e7b61-fc1e-42e8-ad74-bfeb2b0c375b"
}

What would be great:
It would be a huge help if you could include the issue details directly in the payload—similar to what you already do for other events. Adding the name and sequence_id would save us a lot of unnecessary API round-trips.

Proposed addition:

"data": {
    ...
    "issue_detail": {
        "name": "The actual task title",
        "sequence_id": 123
    }
}

Why it matters:
Right now, our bot says "Antoine commented on a task", which isn't very helpful. We'd love it to say "Antoine commented on PROJ-123: Task Title".

Adding this context would make integrations much lighter and more user-friendly without having to pound your API for every single comment.

Thanks for the great work on Plane!

Why should this be worked on?

Currently, the lack of context in the issue_comment payload creates unnecessary friction for anyone building integrations.

  • API Efficiency: To show a simple notification with a title, we have to make an extra GET request to the Plane API for every single comment. This increases server load on both ends.
  • User Experience: Real-time notifications in tools like Zulip or Slack are much less effective when they lack the task subject. Users shouldn't have to click a link just to know which task is being discussed.
  • Consistency: Many other webhook events in Plane already include issue_detail. Adding it to comments would make the webhook behavior more consistent and predictable across the platform.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions