@shortcut/client
    Preparing search index...

    Interface StoryComment

    A Comment is any note added within the Comment field of a Story.

    interface StoryComment {
        app_url: string;
        author_id?: null | string;
        blocker?: boolean;
        created_at: string;
        deleted: boolean;
        entity_type: string;
        external_id?: null | string;
        group_mention_ids: string[];
        id: number;
        linked_to_slack: boolean;
        member_mention_ids: string[];
        mention_ids: string[];
        parent_id?: null | number;
        position: number;
        reactions: StoryReaction[];
        story_id: number;
        text?: null | string;
        unblocks_parent?: boolean;
        updated_at?: null | string;
    }
    Index

    Properties

    app_url author_id? blocker? created_at deleted entity_type external_id? group_mention_ids id linked_to_slack member_mention_ids mention_ids parent_id? position reactions story_id text? unblocks_parent? updated_at?

    Properties

    app_url: string

    The Shortcut application url for the Comment.

    author_id?: null | string

    The unique ID of the Member who is the Comment's author.

    uuid

    blocker?: boolean

    Marks the comment as a blocker that can be surfaced to permissions or teams mentioned in the comment. Can only be used on a top-level comment.

    created_at: string

    The time/date when the Comment was created.

    date-time

    deleted: boolean

    True/false boolean indicating whether the Comment has been deleted.

    entity_type: string

    A string description of this resource.

    external_id?: null | string

    This field can be set to another unique ID. In the case that the Comment has been imported from another tool, the ID in the other tool can be indicated here.

    group_mention_ids: string[]

    The unique IDs of the Group who are mentioned in the Comment.

    id: number

    The unique ID of the Comment.

    int64

    linked_to_slack: boolean

    Whether the Comment is currently the root of a thread that is linked to Slack.

    member_mention_ids: string[]

    The unique IDs of the Member who are mentioned in the Comment.

    mention_ids: string[]

    Deprecated: use member_mention_ids.

    parent_id?: null | number

    The ID of the parent Comment this Comment is threaded under.

    int64

    position: number

    The Comments numerical position in the list from oldest to newest.

    int64

    reactions: StoryReaction[]

    A set of Reactions to this Comment.

    story_id

    story_id: number

    The ID of the Story on which the Comment appears.

    int64

    Optionaltext

    text?: null | string

    The text of the Comment. In the case that the Comment has been deleted, this field can be set to nil.

    unblocks_parent?: boolean

    Marks the comment as an unblocker to its blocker parent. Can only be set on a threaded comment who has a parent with blocker set.

    updated_at?: null | string

    The time/date when the Comment was updated.

    date-time

    Settings

    Member Visibility

    On This Page

    Properties