Type alias ListItemPayload

ListItemPayload: {
    channelId: string;
    completedAt?: string;
    completedBy?: string;
    createdAt: string;
    createdBy: string;
    createdByWebhookId?: string;
    groupId: string;
    id: string;
    mentions?: MentionsPayload;
    message: string;
    note?: {
        content: string;
        createdAt: string;
        createdBy: string;
        mentions?: MentionsPayload;
        updatedAt?: string;
        updatedBy?: string;
    };
    parentListItemId?: string;
    serverId: string;
    updatedAt?: string;
    updatedBy?: string;
}

Type declaration

  • channelId: string

    The ID of the channel

  • Optional completedAt?: string

    The ISO 8601 timestamp that the list item was completed at

  • Optional completedBy?: string

    The ID of the user who completed this list item

  • createdAt: string

    The ISO 8601 timestamp that the list item was created at

  • createdBy: string

    The ID of the user who created this list item (Note: If this event has createdByWebhookId present, this field will still be populated, but can be ignored. In this case, the value of this field will always be Ann6LewA)

  • Optional createdByWebhookId?: string

    The ID of the webhook who created this list item, if it was created by a webhook

  • groupId: string

    The ID of the group

  • id: string

    The ID of the list item

  • Optional mentions?: MentionsPayload
  • message: string

    The message of the list item

  • Optional note?: {
        content: string;
        createdAt: string;
        createdBy: string;
        mentions?: MentionsPayload;
        updatedAt?: string;
        updatedBy?: string;
    }
    • content: string

      The note of the list item

    • createdAt: string

      The ISO 8601 timestamp that the note was created at. If this field is populated, then there's a note associated with the list item

    • createdBy: string

      The ID of the user who created this note

    • Optional mentions?: MentionsPayload
    • Optional updatedAt?: string

      The ISO 8601 timestamp that the note was updated at, if relevant

    • Optional updatedBy?: string

      The ID of the user who updated this note

  • Optional parentListItemId?: string

    The ID of the parent list item if this list item is nested

  • serverId: string

    The ID of the server

  • Optional updatedAt?: string

    The ISO 8601 timestamp that the list item was updated at, if relevant

  • Optional updatedBy?: string

    The ID of the user who updated this list item

Generated using TypeDoc