Interface: ProjectWebhookPayload

Defined in: src/webhooks/payloads.ts:136

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

Extends

• WebhookPayloadBase

Properties

matchedWebhookIds?

optional matchedWebhookIds?: number[];

Defined in: src/webhooks/payloads.ts:59

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.

Inherited from

WebhookPayloadBase.matchedWebhookIds

---

project?

optional project?: object;

Defined in: src/webhooks/payloads.ts:138

Index Signature

[key: string]: unknown

archived?

optional archived?: boolean;

Whether the project is archived.

archivedBy?

optional archivedBy?: object;

Index Signature

[key: string]: unknown

archivedBy.accountId?

optional accountId?: string;

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

archivedBy.accountType?

optional accountType?: "unknown" | string & object | "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

archivedBy.active?

optional active?: boolean;

Whether the user is active.

archivedBy.applicationRoles?

optional applicationRoles?: object;

Index Signature

[key: string]: unknown

archivedBy.applicationRoles.callback?

optional callback?: object;

Index Signature

[key: string]: unknown

archivedBy.applicationRoles.items?

optional items?: object[];

Index Signature

[key: string]: unknown

archivedBy.applicationRoles.max-results?

optional max-results?: number;

archivedBy.applicationRoles.pagingCallback?

optional pagingCallback?: object;

Index Signature

[key: string]: unknown

archivedBy.applicationRoles.size?

optional size?: number;

archivedBy.appType?

optional appType?: 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

archivedBy.avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: string]: unknown

archivedBy.avatarUrls.16x16?

optional 16x16?: string;

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

archivedBy.avatarUrls.24x24?

optional 24x24?: string;

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

archivedBy.avatarUrls.32x32?

optional 32x32?: string;

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

archivedBy.avatarUrls.48x48?

optional 48x48?: string;

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

archivedBy.displayName?

optional displayName?: string;

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

archivedBy.emailAddress?

optional emailAddress?: string;

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

archivedBy.expand?

optional expand?: string;

Expand options that include additional user details in the response.

archivedBy.groups?

optional groups?: object;

Index Signature

[key: string]: unknown

archivedBy.groups.callback?

optional callback?: object;

Index Signature

[key: string]: unknown

archivedBy.groups.items?

optional items?: object[];

Index Signature

[key: string]: unknown

archivedBy.groups.max-results?

optional max-results?: number;

archivedBy.groups.pagingCallback?

optional pagingCallback?: object;

Index Signature

[key: string]: unknown

archivedBy.groups.size?

optional size?: number;

archivedBy.guest?

optional guest?: boolean;

Whether the user is a guest.

archivedBy.locale?

optional locale?: string;

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

archivedBy.self?

optional self?: string;

The URL of the user.

archivedBy.timeZone?

optional timeZone?: 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.

archivedDate?

optional archivedDate?: Date;

The date when the project was archived.

assigneeType?

optional assigneeType?: string & object | "PROJECT_LEAD" | "UNASSIGNED";

The default assignee when creating issues for this project.

avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: string]: unknown

avatarUrls.16x16?

optional 16x16?: string;

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

avatarUrls.24x24?

optional 24x24?: string;

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

avatarUrls.32x32?

optional 32x32?: string;

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

avatarUrls.48x48?

optional 48x48?: string;

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

components?

optional components?: object[];

List of the components contained in the project.

Index Signature

[key: string]: unknown

deleted?

optional deleted?: boolean;

Whether the project is marked as deleted.

deletedBy?

optional deletedBy?: object;

Index Signature

[key: string]: unknown

deletedBy.accountId?

optional accountId?: string;

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

deletedBy.accountType?

optional accountType?: "unknown" | string & object | "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

deletedBy.active?

optional active?: boolean;

Whether the user is active.

deletedBy.applicationRoles?

optional applicationRoles?: object;

Index Signature

[key: string]: unknown

deletedBy.applicationRoles.callback?

optional callback?: object;

Index Signature

[key: string]: unknown

deletedBy.applicationRoles.items?

optional items?: object[];

Index Signature

[key: string]: unknown

deletedBy.applicationRoles.max-results?

optional max-results?: number;

deletedBy.applicationRoles.pagingCallback?

optional pagingCallback?: object;

Index Signature

[key: string]: unknown

deletedBy.applicationRoles.size?

optional size?: number;

deletedBy.appType?

optional appType?: 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

deletedBy.avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: string]: unknown

deletedBy.avatarUrls.16x16?

optional 16x16?: string;

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

deletedBy.avatarUrls.24x24?

optional 24x24?: string;

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

deletedBy.avatarUrls.32x32?

optional 32x32?: string;

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

deletedBy.avatarUrls.48x48?

optional 48x48?: string;

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

deletedBy.displayName?

optional displayName?: string;

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

deletedBy.emailAddress?

optional emailAddress?: string;

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

deletedBy.expand?

optional expand?: string;

Expand options that include additional user details in the response.

deletedBy.groups?

optional groups?: object;

Index Signature

[key: string]: unknown

deletedBy.groups.callback?

optional callback?: object;

Index Signature

[key: string]: unknown

deletedBy.groups.items?

optional items?: object[];

Index Signature

[key: string]: unknown

deletedBy.groups.max-results?

optional max-results?: number;

deletedBy.groups.pagingCallback?

optional pagingCallback?: object;

Index Signature

[key: string]: unknown

deletedBy.groups.size?

optional size?: number;

deletedBy.guest?

optional guest?: boolean;

Whether the user is a guest.

deletedBy.locale?

optional locale?: string;

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

deletedBy.self?

optional self?: string;

The URL of the user.

deletedBy.timeZone?

optional timeZone?: 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.

deletedDate?

optional deletedDate?: Date;

The date when the project was marked as deleted.

description?

optional description?: string;

A brief description of the project.

email?

optional email?: string;

An email address associated with the project.

entityId?

optional entityId?: string;

expand?

optional expand?: string;

Expand options that include additional project details in the response.

favourite?

optional favourite?: boolean;

Whether the project is selected as a favorite.

id?

optional id?: string;

The ID of the project.

insight?

optional insight?: object;

Index Signature

[key: string]: unknown

insight.lastIssueUpdateTime?

optional lastIssueUpdateTime?: Date;

The last issue update time.

insight.totalIssueCount?

optional totalIssueCount?: number;

Total issue count.

isPrivate?

optional isPrivate?: boolean;

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

issueTypeHierarchy?

optional issueTypeHierarchy?: object;

Index Signature

[key: string]: unknown

issueTypeHierarchy.levels?

optional levels?: object[];

Details about the hierarchy level.

Index Signature

[key: string]: unknown

issueTypes?

optional issueTypes?: object[];

List of the issue types available in the project.

Index Signature

[key: string]: unknown

key?

optional key?: string;

The key of the project.

landingPageInfo?

optional landingPageInfo?: object;

Index Signature

[key: string]: unknown

landingPageInfo.attributes?

optional attributes?: Record<string, string>;

landingPageInfo.boardId?

optional boardId?: number;

landingPageInfo.boardName?

optional boardName?: string;

landingPageInfo.projectKey?

optional projectKey?: string;

landingPageInfo.projectType?

optional projectType?: string;

landingPageInfo.queueCategory?

optional queueCategory?: string;

landingPageInfo.queueId?

optional queueId?: number;

landingPageInfo.queueName?

optional queueName?: string;

landingPageInfo.simpleBoard?

optional simpleBoard?: boolean;

landingPageInfo.simplified?

optional simplified?: boolean;

landingPageInfo.url?

optional url?: string;

lead?

optional lead?: object;

Index Signature

[key: string]: unknown

lead.accountId?

optional accountId?: string;

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

lead.accountType?

optional accountType?: "unknown" | string & object | "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

lead.active?

optional active?: boolean;

Whether the user is active.

lead.applicationRoles?

optional applicationRoles?: object;

Index Signature

[key: string]: unknown

lead.applicationRoles.callback?

optional callback?: object;

Index Signature

[key: string]: unknown

lead.applicationRoles.items?

optional items?: object[];

Index Signature

[key: string]: unknown

lead.applicationRoles.max-results?

optional max-results?: number;

lead.applicationRoles.pagingCallback?

optional pagingCallback?: object;

Index Signature

[key: string]: unknown

lead.applicationRoles.size?

optional size?: number;

lead.appType?

optional appType?: 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

lead.avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: string]: unknown

lead.avatarUrls.16x16?

optional 16x16?: string;

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

lead.avatarUrls.24x24?

optional 24x24?: string;

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

lead.avatarUrls.32x32?

optional 32x32?: string;

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

lead.avatarUrls.48x48?

optional 48x48?: string;

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

lead.displayName?

optional displayName?: string;

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

lead.emailAddress?

optional emailAddress?: string;

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

lead.expand?

optional expand?: string;

Expand options that include additional user details in the response.

lead.groups?

optional groups?: object;

Index Signature

[key: string]: unknown

lead.groups.callback?

optional callback?: object;

Index Signature

[key: string]: unknown

lead.groups.items?

optional items?: object[];

Index Signature

[key: string]: unknown

lead.groups.max-results?

optional max-results?: number;

lead.groups.pagingCallback?

optional pagingCallback?: object;

Index Signature

[key: string]: unknown

lead.groups.size?

optional size?: number;

lead.guest?

optional guest?: boolean;

Whether the user is a guest.

lead.locale?

optional locale?: string;

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

lead.self?

optional self?: string;

The URL of the user.

lead.timeZone?

optional timeZone?: 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.

name?

optional name?: string;

The name of the project.

permissions?

optional permissions?: object;

Index Signature

[key: string]: unknown

permissions.canEdit?

optional canEdit?: boolean;

Whether the logged user can edit the project.

projectCategory?

optional projectCategory?: object;

Index Signature

[key: string]: unknown

projectCategory.description?

optional description?: string;

The description of the project category.

projectCategory.id?

optional id?: string;

The ID of the project category.

projectCategory.name?

optional name?: string;

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

projectCategory.self?

optional self?: string;

The URL of the project category.

projectTypeKey?

optional projectTypeKey?: 
  | string & object
  | "software"
  | "service_desk"
  | "business"
  | "product_discovery"
  | "customer_service";

The project type of the project.

properties?

optional properties?: Record<string, any>;

Map of project properties. Only the properties named in the request's properties query parameter are returned, so this is an empty object when that parameter is omitted.

retentionTillDate?

optional retentionTillDate?: Date;

The date when the project is deleted permanently.

roles?

optional roles?: Record<string, string>;

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

self?

optional self?: string;

The URL of the project details.

simplified?

optional simplified?: boolean;

Whether the project is simplified.

style?

optional style?: "classic" | string & object | "next-gen";

The type of the project.

url?

optional url?: string;

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

uuid?

optional uuid?: string;

Unique ID for next-gen projects.

versions?

optional versions?: object[];

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

Index Signature

[key: string]: unknown

---

timestamp

timestamp: number;

Defined in: src/webhooks/payloads.ts:50

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

Inherited from

WebhookPayloadBase.timestamp

---

webhookEvent

webhookEvent: ProjectWebhookEvent;

Defined in: src/webhooks/payloads.ts:137

The event, and the field to switch on.

Overrides

WebhookPayloadBase.webhookEvent