Skip to main content

entity_comments_requested event

This event is sent to your app when a user opens the comments tab of a Work Object flexpane, refreshes the comments, or requests the next page of comments

Facts

Required Scopes
No scopes required!
Compatible APIs

Usage info​

This example includes both the event wrapper and the event structure for the entity_comments_requested event.

{
    "token": "XXYYZZ",
    "team_id": "T123ABC456",
    "api_app_id": "A123ABC456",
    "event": {
        "type": "entity_comments_requested",
        "user": "U0123456",
        "external_ref": {
            "id": "123",
            "type": "my-type"
        },
        "entity_url": "https://example.com/document/123",
        "link": {
            "url": "https://example.com/document/123",
            "domain": "example.com"
        },
        "cursor": "your_app_sourced_pagination_cursor",
        "limit": 100,
        "thread_root_id": "comment-unique-identifier-001", // present when the replies for a specific comment thread are being requested
        "event_ts": "123456789.1234566",
        "trigger_id": "1234567890123.1234567890123.abcdef01234567890abcdef012345689"
    },
    "type": "event_callback",
    "authorizations": [
        {
            "team_id": "T123ABC456",
            "user_id": "U123ABC456",
            "is_bot": false,
            "is_enterprise_install": false,
        }
    ],
    "event_id": "Ev123ABC456",
    "event_time": 123456789
}

This event is sent to your app when a user opens the comments tab of a Work Objects flexpane, refreshes the comments, or scrolls to request the next page of comments. Respond by calling the entity.presentComments API method with the requested comments.

When thread_root_id is present, the app should return the replies for that comment thread instead of top-level comments. When it's absent, return top-level comments only. The cursor field, when present, is the pagination cursor your app supplied in a previous response and should be used to return the next page of comments. Refer to bidirectional comments in Work Objects for more details.