jira.js
    Preparing search index...

    Interface IssueTypeWebhookPayload

    An issue type changed. Undocumented; issueType is named after the entity.

    interface IssueTypeWebhookPayload {
        issueType?: {
            avatarId?: number;
            description?: string;
            entityId?: string;
            hierarchyLevel?: number;
            iconUrl?: string;
            id?: string;
            name?: string;
            scope?: {
                project?: {
                    avatarUrls?: {
                        "16x16"?: string;
                        "24x24"?: string;
                        "32x32"?: string;
                        "48x48"?: string;
                        [key: string]: unknown;
                    };
                    id?: string;
                    key?: string;
                    name?: string;
                    projectCategory?: {
                        description?: string;
                        id?: string;
                        name?: string;
                        self?: string;
                        [key: string]: unknown;
                    };
                    projectTypeKey?: | string & {}
                    | "software"
                    | "service_desk"
                    | "business"
                    | "product_discovery"
                    | "customer_service";
                    self?: string;
                    simplified?: boolean;
                    [key: string]: unknown;
                };
                type?: string & {}
                | "PROJECT"
                | "TEMPLATE";
                [key: string]: unknown;
            };
            self?: string;
            subtask?: boolean;
            untranslatedName?: string;
            [key: string]: unknown;
        };
        matchedWebhookIds?: number[];
        timestamp: number;
        webhookEvent: IssueTypeWebhookEvent;
    }

    Hierarchy (View Summary)

    Index
    issueType?: {
        avatarId?: number;
        description?: string;
        entityId?: string;
        hierarchyLevel?: number;
        iconUrl?: string;
        id?: string;
        name?: string;
        scope?: {
            project?: {
                avatarUrls?: {
                    "16x16"?: string;
                    "24x24"?: string;
                    "32x32"?: string;
                    "48x48"?: string;
                    [key: string]: unknown;
                };
                id?: string;
                key?: string;
                name?: string;
                projectCategory?: {
                    description?: string;
                    id?: string;
                    name?: string;
                    self?: string;
                    [key: string]: unknown;
                };
                projectTypeKey?: | string & {}
                | "software"
                | "service_desk"
                | "business"
                | "product_discovery"
                | "customer_service";
                self?: string;
                simplified?: boolean;
                [key: string]: unknown;
            };
            type?: string & {}
            | "PROJECT"
            | "TEMPLATE";
            [key: string]: unknown;
        };
        self?: string;
        subtask?: boolean;
        untranslatedName?: string;
        [key: string]: unknown;
    }

    Type Declaration

    • [key: string]: unknown
    • OptionalavatarId?: number

      The ID of the issue type's avatar.

    • Optionaldescription?: string

      The description of the issue type.

    • OptionalentityId?: string

      Unique ID for next-gen projects.

    • OptionalhierarchyLevel?: number

      Hierarchy level of the issue type.

    • OptionaliconUrl?: string

      The URL of the issue type's avatar.

    • Optionalid?: string

      The ID of the issue type.

    • Optionalname?: string

      The name of the issue type.

    • Optionalscope?: {
          project?: {
              avatarUrls?: {
                  "16x16"?: string;
                  "24x24"?: string;
                  "32x32"?: string;
                  "48x48"?: string;
                  [key: string]: unknown;
              };
              id?: string;
              key?: string;
              name?: string;
              projectCategory?: {
                  description?: string;
                  id?: string;
                  name?: string;
                  self?: string;
                  [key: string]: unknown;
              };
              projectTypeKey?: | string & {}
              | "software"
              | "service_desk"
              | "business"
              | "product_discovery"
              | "customer_service";
              self?: string;
              simplified?: boolean;
              [key: string]: unknown;
          };
          type?: string & {}
          | "PROJECT"
          | "TEMPLATE";
          [key: string]: unknown;
      }
      • Optionalproject?: {
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            id?: string;
            key?: string;
            name?: string;
            projectCategory?: {
                description?: string;
                id?: string;
                name?: string;
                self?: string;
                [key: string]: unknown;
            };
            projectTypeKey?: | string & {}
            | "software"
            | "service_desk"
            | "business"
            | "product_discovery"
            | "customer_service";
            self?: string;
            simplified?: boolean;
            [key: string]: unknown;
        }
        • OptionalavatarUrls?: {
              "16x16"?: string;
              "24x24"?: string;
              "32x32"?: string;
              "48x48"?: string;
              [key: string]: unknown;
          }
          • Optional16x16?: string

            The URL of the item's 16x16 pixel avatar.

          • Optional24x24?: string

            The URL of the item's 24x24 pixel avatar.

          • Optional32x32?: string

            The URL of the item's 32x32 pixel avatar.

          • Optional48x48?: string

            The URL of the item's 48x48 pixel avatar.

        • Optionalid?: string

          The ID of the project.

        • Optionalkey?: string

          The key of the project.

        • Optionalname?: string

          The name of the project.

        • OptionalprojectCategory?: {
              description?: string;
              id?: string;
              name?: string;
              self?: string;
              [key: string]: unknown;
          }
          • Optionaldescription?: string

            The name of the project category.

          • Optionalid?: string

            The ID of the project category.

          • Optionalname?: string

            The description of the project category.

          • Optionalself?: string

            The URL of the project category.

        • OptionalprojectTypeKey?:
              | string & {}
              | "software"
              | "service_desk"
              | "business"
              | "product_discovery"
              | "customer_service"

          The project type of the project.

        • Optionalself?: string

          The URL of the project details.

        • Optionalsimplified?: boolean

          Whether or not the project is simplified.

      • Optionaltype?: string & {} | "PROJECT" | "TEMPLATE"

        The type of scope.

    • Optionalself?: string

      The URL of these issue type details.

    • Optionalsubtask?: boolean

      Whether this issue type is used to create subtasks.

    • OptionaluntranslatedName?: string
    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: IssueTypeWebhookEvent

    The event, and the field to switch on.