Interface ProjectWebhookPayload

Type Declaration

• [key: string]: unknown

• Optionalarchived?: boolean

  Whether the project is archived.

• OptionalarchivedBy?: {
      accountId?: string;
      accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer";
      active?: boolean;
      applicationRoles?: {
          callback?: { [key: string]: unknown };
          items?: {
              defaultGroups?: (...)[];
              defaultGroupsDetails?: (...)[];
              defined?: boolean;
              groupDetails?: (...)[];
              groups?: (...)[];
              hasUnlimitedSeats?: boolean;
              key?: string;
              name?: string;
              numberOfSeats?: number;
              platform?: boolean;
              remainingSeats?: number;
              selectedByDefault?: boolean;
              userCount?: number;
              userCountDescription?: string;
              [key: string]: unknown;
          }[];
          "max-results"?: number;
          pagingCallback?: { [key: string]: unknown };
          size?: number;
          [key: string]: unknown;
      };
      appType?: string;
      avatarUrls?: {
          "16x16"?: string;
          "24x24"?: string;
          "32x32"?: string;
          "48x48"?: string;
          [key: string]: unknown;
      };
      displayName?: string;
      emailAddress?: string;
      expand?: string;
      groups?: {
          callback?: { [key: string]: unknown };
          items?: {
              groupId?: string | null;
              name?: string;
              self?: string;
              [key: string]: unknown;
          }[];
          "max-results"?: number;
          pagingCallback?: { [key: string]: unknown };
          size?: number;
          [key: string]: unknown;
      };
      guest?: boolean;
      locale?: string;
      self?: string;
      timeZone?: string;
      [key: string]: unknown;
  }

  • OptionalaccountId?: string

    The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.

  • OptionalaccountType?: "unknown" | string & {} | "atlassian" | "app" | "customer"

    The user account type. Can take the following values:

    • atlassian regular Atlassian user account
    • app system account used for Connect applications and OAuth to represent external systems
    • customer Jira Service Desk account representing an external service desk

  • Optionalactive?: boolean

    Whether the user is active.

  • OptionalapplicationRoles?: {
        callback?: { [key: string]: unknown };
        items?: {
            defaultGroups?: (...)[];
            defaultGroupsDetails?: (...)[];
            defined?: boolean;
            groupDetails?: (...)[];
            groups?: (...)[];
            hasUnlimitedSeats?: boolean;
            key?: string;
            name?: string;
            numberOfSeats?: number;
            platform?: boolean;
            remainingSeats?: number;
            selectedByDefault?: boolean;
            userCount?: number;
            userCountDescription?: string;
            [key: string]: unknown;
        }[];
        "max-results"?: number;
        pagingCallback?: { [key: string]: unknown };
        size?: number;
        [key: string]: unknown;
    }

  • OptionalappType?: string

    The app type of the user account when accountType is 'app'. Can take the following values:

    • service Service Account
    • agent Rovo Agent Account
    • unknown Unknown app type

  • 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.

  • OptionaldisplayName?: string

    The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

  • OptionalemailAddress?: string

    The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

  • Optionalexpand?: string

    Expand options that include additional user details in the response.

  • Optionalgroups?: {
        callback?: { [key: string]: unknown };
        items?: {
            groupId?: string | null;
            name?: string;
            self?: string;
            [key: string]: unknown;
        }[];
        "max-results"?: number;
        pagingCallback?: { [key: string]: unknown };
        size?: number;
        [key: string]: unknown;
    }

  • Optionalguest?: boolean

    Whether the user is a guest.

  • Optionallocale?: string

    The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

  • Optionalself?: string

    The URL of the user.

  • OptionaltimeZone?: string

    The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned.

• OptionalarchivedDate?: Date

  The date when the project was archived.

• OptionalassigneeType?: string & {} | "PROJECT_LEAD" | "UNASSIGNED"

  The default assignee when creating issues for this project.

• 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.

• Optionalcomponents?: {
      ari?: string;
      assignee?: {
          accountId?: string;
          accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer";
          active?: boolean;
          applicationRoles?: {
              callback?: { [key: ...]: ... };
              items?: (...)[];
              "max-results"?: number;
              pagingCallback?: { [key: ...]: ... };
              size?: number;
              [key: string]: unknown;
          };
          appType?: string;
          avatarUrls?: {
              "16x16"?: string;
              "24x24"?: string;
              "32x32"?: string;
              "48x48"?: string;
              [key: string]: unknown;
          };
          displayName?: string;
          emailAddress?: string;
          expand?: string;
          groups?: {
              callback?: { [key: ...]: ... };
              items?: (...)[];
              "max-results"?: number;
              pagingCallback?: { [key: ...]: ... };
              size?: number;
              [key: string]: unknown;
          };
          guest?: boolean;
          locale?: string;
          self?: string;
          timeZone?: string;
          [key: string]: unknown;
      };
      assigneeType?: | string & {}
      | "PROJECT_DEFAULT"
      | "COMPONENT_LEAD"
      | "PROJECT_LEAD"
      | "UNASSIGNED";
      description?: string;
      id?: string;
      isAssigneeTypeValid?: boolean;
      lead?: {
          accountId?: string;
          accountType?: "unknown"
          | string & {}
          | "atlassian"
          | "app"
          | "customer";
          active?: boolean;
          applicationRoles?: {
              callback?: { [key: ...]: ... };
              items?: (...)[];
              "max-results"?: number;
              pagingCallback?: { [key: ...]: ... };
              size?: number;
              [key: string]: unknown;
          };
          appType?: string;
          avatarUrls?: {
              "16x16"?: string;
              "24x24"?: string;
              "32x32"?: string;
              "48x48"?: string;
              [key: string]: unknown;
          };
          displayName?: string;
          emailAddress?: string;
          expand?: string;
          groups?: {
              callback?: { [key: ...]: ... };
              items?: (...)[];
              "max-results"?: number;
              pagingCallback?: { [key: ...]: ... };
              size?: number;
              [key: string]: unknown;
          };
          guest?: boolean;
          locale?: string;
          self?: string;
          timeZone?: string;
          [key: string]: unknown;
      };
      leadAccountId?: string;
      metadata?: Record<string, any>;
      name?: string;
      project?: string;
      projectId?: number;
      realAssignee?: {
          accountId?: string;
          accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer";
          active?: boolean;
          applicationRoles?: {
              callback?: { [key: ...]: ... };
              items?: (...)[];
              "max-results"?: number;
              pagingCallback?: { [key: ...]: ... };
              size?: number;
              [key: string]: unknown;
          };
          appType?: string;
          avatarUrls?: {
              "16x16"?: string;
              "24x24"?: string;
              "32x32"?: string;
              "48x48"?: string;
              [key: string]: unknown;
          };
          displayName?: string;
          emailAddress?: string;
          expand?: string;
          groups?: {
              callback?: { [key: ...]: ... };
              items?: (...)[];
              "max-results"?: number;
              pagingCallback?: { [key: ...]: ... };
              size?: number;
              [key: string]: unknown;
          };
          guest?: boolean;
          locale?: string;
          self?: string;
          timeZone?: string;
          [key: string]: unknown;
      };
      realAssigneeType?: | string & {}
      | "PROJECT_DEFAULT"
      | "COMPONENT_LEAD"
      | "PROJECT_LEAD"
      | "UNASSIGNED";
      self?: string;
      [key: string]: unknown;
  }[]

  List of the components contained in the project.

• Optionaldeleted?: boolean

  Whether the project is marked as deleted.

• OptionaldeletedBy?: {
      accountId?: string;
      accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer";
      active?: boolean;
      applicationRoles?: {
          callback?: { [key: string]: unknown };
          items?: {
              defaultGroups?: (...)[];
              defaultGroupsDetails?: (...)[];
              defined?: boolean;
              groupDetails?: (...)[];
              groups?: (...)[];
              hasUnlimitedSeats?: boolean;
              key?: string;
              name?: string;
              numberOfSeats?: number;
              platform?: boolean;
              remainingSeats?: number;
              selectedByDefault?: boolean;
              userCount?: number;
              userCountDescription?: string;
              [key: string]: unknown;
          }[];
          "max-results"?: number;
          pagingCallback?: { [key: string]: unknown };
          size?: number;
          [key: string]: unknown;
      };
      appType?: string;
      avatarUrls?: {
          "16x16"?: string;
          "24x24"?: string;
          "32x32"?: string;
          "48x48"?: string;
          [key: string]: unknown;
      };
      displayName?: string;
      emailAddress?: string;
      expand?: string;
      groups?: {
          callback?: { [key: string]: unknown };
          items?: {
              groupId?: string | null;
              name?: string;
              self?: string;
              [key: string]: unknown;
          }[];
          "max-results"?: number;
          pagingCallback?: { [key: string]: unknown };
          size?: number;
          [key: string]: unknown;
      };
      guest?: boolean;
      locale?: string;
      self?: string;
      timeZone?: string;
      [key: string]: unknown;
  }

  • OptionalaccountId?: string

    The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.

  • OptionalaccountType?: "unknown" | string & {} | "atlassian" | "app" | "customer"

    The user account type. Can take the following values:

    • atlassian regular Atlassian user account
    • app system account used for Connect applications and OAuth to represent external systems
    • customer Jira Service Desk account representing an external service desk

  • Optionalactive?: boolean

    Whether the user is active.

  • OptionalapplicationRoles?: {
        callback?: { [key: string]: unknown };
        items?: {
            defaultGroups?: (...)[];
            defaultGroupsDetails?: (...)[];
            defined?: boolean;
            groupDetails?: (...)[];
            groups?: (...)[];
            hasUnlimitedSeats?: boolean;
            key?: string;
            name?: string;
            numberOfSeats?: number;
            platform?: boolean;
            remainingSeats?: number;
            selectedByDefault?: boolean;
            userCount?: number;
            userCountDescription?: string;
            [key: string]: unknown;
        }[];
        "max-results"?: number;
        pagingCallback?: { [key: string]: unknown };
        size?: number;
        [key: string]: unknown;
    }

  • OptionalappType?: string

    The app type of the user account when accountType is 'app'. Can take the following values:

    • service Service Account
    • agent Rovo Agent Account
    • unknown Unknown app type

  • 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.

  • OptionaldisplayName?: string

    The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

  • OptionalemailAddress?: string

    The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

  • Optionalexpand?: string

    Expand options that include additional user details in the response.

  • Optionalgroups?: {
        callback?: { [key: string]: unknown };
        items?: {
            groupId?: string | null;
            name?: string;
            self?: string;
            [key: string]: unknown;
        }[];
        "max-results"?: number;
        pagingCallback?: { [key: string]: unknown };
        size?: number;
        [key: string]: unknown;
    }

  • Optionalguest?: boolean

    Whether the user is a guest.

  • Optionallocale?: string

    The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

  • Optionalself?: string

    The URL of the user.

  • OptionaltimeZone?: string

    The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned.

• OptionaldeletedDate?: Date

  The date when the project was marked as deleted.

• Optionaldescription?: string

  A brief description of the project.

• Optionalemail?: string

  An email address associated with the project.

• OptionalentityId?: string

• Optionalexpand?: string

  Expand options that include additional project details in the response.

• Optionalfavourite?: boolean

  Whether the project is selected as a favorite.

• Optionalid?: string

  The ID of the project.

• Optionalinsight?: { lastIssueUpdateTime?: Date; totalIssueCount?: number; [key: string]: unknown }

  • OptionallastIssueUpdateTime?: Date

    The last issue update time.

  • OptionaltotalIssueCount?: number

    Total issue count.

• OptionalisPrivate?: boolean

  Whether the project is private from the user's perspective. This means the user can't see the project or any associated issues.

• OptionalissueTypeHierarchy?: {
      levels?: {
          hierarchyLevelNumber?: number;
          issueTypeIds?: number[];
          level?: number;
          name?: string;
          [key: string]: unknown;
      }[];
      [key: string]: unknown;
  }

  • Optionallevels?: {
        hierarchyLevelNumber?: number;
        issueTypeIds?: number[];
        level?: number;
        name?: string;
        [key: string]: unknown;
    }[]

    Details about the hierarchy level.

• OptionalissueTypes?: {
      avatarId?: number;
      description?: string;
      entityId?: string;
      hierarchyLevel?: number;
      iconUrl?: string;
      id?: string;
      name?: string;
      scope?: {
          project?: {
              avatarUrls?: {
                  "16x16"?: ...;
                  "24x24"?: ...;
                  "32x32"?: ...;
                  "48x48"?: ...;
                  [key: ...]: ...;
              };
              id?: string;
              key?: string;
              name?: string;
              projectCategory?: {
                  description?: ...;
                  id?: ...;
                  name?: ...;
                  self?: ...;
                  [key: ...]: ...;
              };
              projectTypeKey?: | (...) & (...)
              | "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;
  }[]

  List of the issue types available in the project.

• Optionalkey?: string

  The key of the project.

• OptionallandingPageInfo?: {
      attributes?: Record<string, any>;
      boardId?: number;
      boardName?: string;
      projectKey?: string;
      projectType?: string;
      queueCategory?: string;
      queueId?: number;
      queueName?: string;
      simpleBoard?: boolean;
      simplified?: boolean;
      url?: string;
      [key: string]: unknown;
  }

• Optionallead?: {
      accountId?: string;
      accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer";
      active?: boolean;
      applicationRoles?: {
          callback?: { [key: string]: unknown };
          items?: {
              defaultGroups?: (...)[];
              defaultGroupsDetails?: (...)[];
              defined?: boolean;
              groupDetails?: (...)[];
              groups?: (...)[];
              hasUnlimitedSeats?: boolean;
              key?: string;
              name?: string;
              numberOfSeats?: number;
              platform?: boolean;
              remainingSeats?: number;
              selectedByDefault?: boolean;
              userCount?: number;
              userCountDescription?: string;
              [key: string]: unknown;
          }[];
          "max-results"?: number;
          pagingCallback?: { [key: string]: unknown };
          size?: number;
          [key: string]: unknown;
      };
      appType?: string;
      avatarUrls?: {
          "16x16"?: string;
          "24x24"?: string;
          "32x32"?: string;
          "48x48"?: string;
          [key: string]: unknown;
      };
      displayName?: string;
      emailAddress?: string;
      expand?: string;
      groups?: {
          callback?: { [key: string]: unknown };
          items?: {
              groupId?: string | null;
              name?: string;
              self?: string;
              [key: string]: unknown;
          }[];
          "max-results"?: number;
          pagingCallback?: { [key: string]: unknown };
          size?: number;
          [key: string]: unknown;
      };
      guest?: boolean;
      locale?: string;
      self?: string;
      timeZone?: string;
      [key: string]: unknown;
  }

  • OptionalaccountId?: string

    The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.

  • OptionalaccountType?: "unknown" | string & {} | "atlassian" | "app" | "customer"

    The user account type. Can take the following values:

    • atlassian regular Atlassian user account
    • app system account used for Connect applications and OAuth to represent external systems
    • customer Jira Service Desk account representing an external service desk

  • Optionalactive?: boolean

    Whether the user is active.

  • OptionalapplicationRoles?: {
        callback?: { [key: string]: unknown };
        items?: {
            defaultGroups?: (...)[];
            defaultGroupsDetails?: (...)[];
            defined?: boolean;
            groupDetails?: (...)[];
            groups?: (...)[];
            hasUnlimitedSeats?: boolean;
            key?: string;
            name?: string;
            numberOfSeats?: number;
            platform?: boolean;
            remainingSeats?: number;
            selectedByDefault?: boolean;
            userCount?: number;
            userCountDescription?: string;
            [key: string]: unknown;
        }[];
        "max-results"?: number;
        pagingCallback?: { [key: string]: unknown };
        size?: number;
        [key: string]: unknown;
    }

  • OptionalappType?: string

    The app type of the user account when accountType is 'app'. Can take the following values:

    • service Service Account
    • agent Rovo Agent Account
    • unknown Unknown app type

  • 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.

  • OptionaldisplayName?: string

    The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

  • OptionalemailAddress?: string

    The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

  • Optionalexpand?: string

    Expand options that include additional user details in the response.

  • Optionalgroups?: {
        callback?: { [key: string]: unknown };
        items?: {
            groupId?: string | null;
            name?: string;
            self?: string;
            [key: string]: unknown;
        }[];
        "max-results"?: number;
        pagingCallback?: { [key: string]: unknown };
        size?: number;
        [key: string]: unknown;
    }

  • Optionalguest?: boolean

    Whether the user is a guest.

  • Optionallocale?: string

    The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

  • Optionalself?: string

    The URL of the user.

  • OptionaltimeZone?: string

    The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned.

• Optionalname?: string

  The name of the project.

• Optionalpermissions?: { canEdit?: boolean; [key: string]: unknown }

  • OptionalcanEdit?: boolean

    Whether the logged user can edit the project.

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

  • Optionaldescription?: string

    The description of the project category.

  • Optionalid?: string

    The ID of the project category.

  • Optionalname?: string

    The name of the project category. Required on create, optional on update.

  • Optionalself?: string

    The URL of the project category.

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

  The project type of the project.

• Optionalproperties?: Record<string, any>

  Map of project properties

• OptionalretentionTillDate?: Date

  The date when the project is deleted permanently.

• Optionalroles?: Record<string, any>

  The name and self URL for each role defined in the project. For more information, see Create project role.

• Optionalself?: string

  The URL of the project details.

• Optionalsimplified?: boolean

  Whether the project is simplified.

• Optionalstyle?: "classic" | string & {} | "next-gen"

  The type of the project.

• Optionalurl?: string

  A link to information about this project, such as project documentation.

• Optionaluuid?: string

  Unique ID for next-gen projects.

• Optionalversions?: {
      approvers?: {
          accountId?: string;
          declineReason?: string;
          description?: string;
          status?: string;
          [key: string]: unknown;
      }[];
      archived?: boolean;
      description?: string;
      driver?: string;
      expand?: string;
      id?: string;
      issuesStatusForFixVersion?: {
          done?: number;
          inProgress?: number;
          toDo?: number;
          unmapped?: number;
          [key: string]: unknown;
      };
      moveUnfixedIssuesTo?: string;
      name?: string;
      operations?: {
          href?: string;
          iconClass?: string;
          id?: string;
          label?: string;
          styleClass?: string;
          title?: string;
          weight?: number;
          [key: string]: unknown;
      }[];
      overdue?: boolean;
      projectId?: number;
      released?: boolean;
      releaseDate?: string;
      self?: string;
      startDate?: string;
      userReleaseDate?: string;
      userStartDate?: string;
      [key: string]: unknown;
  }[]

  The versions defined in the project. For more information, see Create version.