jira.js
    Preparing search index...

    Interface BoardWebhookPayload

    A board changed. Undocumented; board is named after the entity.

    interface BoardWebhookPayload {
        board?: {
            admins?: {
                groups?: { name?: string; self?: string; [key: string]: unknown }[];
                users?: {
                    accountId?: string;
                    active?: boolean;
                    avatarUrls?: {
                        "16x16"?: string;
                        "24x24"?: string;
                        "32x32"?: string;
                        "48x48"?: string;
                        [key: string]: unknown;
                    };
                    displayName?: string;
                    self?: string;
                    [key: string]: unknown;
                }[];
                [key: string]: unknown;
            };
            canEdit?: boolean;
            favourite?: boolean;
            id?: number;
            isPrivate?: boolean;
            location?: {
                avatarURI?: string;
                displayName?: string;
                name?: string;
                projectId?: number;
                projectKey?: string;
                projectName?: string;
                projectTypeKey?: string;
                userAccountId?: string;
                userId?: number;
                [key: string]: unknown;
            };
            name?: string;
            self?: string;
            type?: string & {}
            | "simple"
            | "scrum"
            | "kanban";
            [key: string]: unknown;
        };
        matchedWebhookIds?: number[];
        timestamp: number;
        webhookEvent: BoardWebhookEvent;
    }

    Hierarchy (View Summary)

    Index
    board? matchedWebhookIds? timestamp webhookEvent
    board?: {
        admins?: {
            groups?: { name?: string; self?: string; [key: string]: unknown }[];
            users?: {
                accountId?: string;
                active?: boolean;
                avatarUrls?: {
                    "16x16"?: string;
                    "24x24"?: string;
                    "32x32"?: string;
                    "48x48"?: string;
                    [key: string]: unknown;
                };
                displayName?: string;
                self?: string;
                [key: string]: unknown;
            }[];
            [key: string]: unknown;
        };
        canEdit?: boolean;
        favourite?: boolean;
        id?: number;
        isPrivate?: boolean;
        location?: {
            avatarURI?: string;
            displayName?: string;
            name?: string;
            projectId?: number;
            projectKey?: string;
            projectName?: string;
            projectTypeKey?: string;
            userAccountId?: string;
            userId?: number;
            [key: string]: unknown;
        };
        name?: string;
        self?: string;
        type?: string & {}
        | "simple"
        | "scrum"
        | "kanban";
        [key: string]: unknown;
    }

    Type Declaration

    • [key: string]: unknown
    • Optionaladmins?: {
          groups?: { name?: string; self?: string; [key: string]: unknown }[];
          users?: {
              accountId?: string;
              active?: boolean;
              avatarUrls?: {
                  "16x16"?: string;
                  "24x24"?: string;
                  "32x32"?: string;
                  "48x48"?: string;
                  [key: string]: unknown;
              };
              displayName?: string;
              self?: string;
              [key: string]: unknown;
          }[];
          [key: string]: unknown;
      }

      The users and groups who own the board.

    • OptionalcanEdit?: boolean

      Whether the board can be edited.

    • Optionalfavourite?: boolean

      Whether the board is selected as a favorite.

    • Optionalid?: number

      The ID of the board.

    • OptionalisPrivate?: boolean

      Whether the board is private.

    • Optionallocation?: {
          avatarURI?: string;
          displayName?: string;
          name?: string;
          projectId?: number;
          projectKey?: string;
          projectName?: string;
          projectTypeKey?: string;
          userAccountId?: string;
          userId?: number;
          [key: string]: unknown;
      }

      The container that the board is located in.

    • Optionalname?: string

      The name of the board.

    • Optionalself?: string

      The URL of the board.

    • Optionaltype?: string & {} | "simple" | "scrum" | "kanban"

      The type the board.

    matchedWebhookIds?: number[]

    The registrations this delivery answered. Present only on a webhook registered through the REST API, where one event can match several of them at once.

    timestamp: number

    When Jira raised the event, in milliseconds since the epoch.

    webhookEvent: BoardWebhookEvent

    The event, and the field to switch on.

    Settings
    Member Visibility

    On This Page
    Properties