Interface: IssueLinkWebhookPayload

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

Two issues were linked or unlinked. Undocumented; issueLink is named after the entity.

Extends

• WebhookPayloadBase

Properties

issueLink?

optional issueLink?: object;

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

Index Signature

[key: string]: unknown

id?

optional id?: string;

The ID of the issue link.

inwardIssue?

optional inwardIssue?: object;

Index Signature

[key: string]: unknown

inwardIssue.fields?

optional fields?: object;

Index Signature

[key: string]: unknown

inwardIssue.fields.assignee?

optional assignee?: object;

Index Signature

[key: string]: unknown

inwardIssue.fields.assignee.accountId?

optional accountId?: string;

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

inwardIssue.fields.assignee.accountType?

optional accountType?: string;

The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)

inwardIssue.fields.assignee.active?

optional active?: boolean;

Whether the user is active.

inwardIssue.fields.assignee.avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: string]: unknown

inwardIssue.fields.assignee.avatarUrls.16x16?

optional 16x16?: ... | ...;

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

inwardIssue.fields.assignee.avatarUrls.24x24?

optional 24x24?: ... | ...;

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

inwardIssue.fields.assignee.avatarUrls.32x32?

optional 32x32?: ... | ...;

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

inwardIssue.fields.assignee.avatarUrls.48x48?

optional 48x48?: ... | ...;

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

inwardIssue.fields.assignee.displayName?

optional displayName?: string;

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

inwardIssue.fields.assignee.emailAddress?

optional emailAddress?: string;

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

inwardIssue.fields.assignee.self?

optional self?: string;

The URL of the user.

inwardIssue.fields.assignee.timeZone?

optional timeZone?: string;

The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.

inwardIssue.fields.issuetype?

optional issuetype?: object;

The type of the linked issue.

Index Signature

[key: string]: unknown

inwardIssue.fields.issuetype.avatarId?

optional avatarId?: number;

The ID of the issue type's avatar.

inwardIssue.fields.issuetype.description?

optional description?: string;

The description of the issue type.

inwardIssue.fields.issuetype.entityId?

optional entityId?: string;

Unique ID for next-gen projects.

inwardIssue.fields.issuetype.hierarchyLevel?

optional hierarchyLevel?: number;

Hierarchy level of the issue type.

inwardIssue.fields.issuetype.iconUrl?

optional iconUrl?: string;

The URL of the issue type's avatar.

inwardIssue.fields.issuetype.id?

optional id?: string;

The ID of the issue type.

inwardIssue.fields.issuetype.name?

optional name?: string;

The name of the issue type.

inwardIssue.fields.issuetype.scope?

optional scope?: object;

Index Signature

[key: string]: unknown

inwardIssue.fields.issuetype.scope.project?

optional project?: ... | ...;

inwardIssue.fields.issuetype.scope.type?

optional type?: ... | ... | ... | ...;

The type of scope.

inwardIssue.fields.issuetype.self?

optional self?: string;

The URL of these issue type details.

inwardIssue.fields.issuetype.subtask?

optional subtask?: boolean;

Whether this issue type is used to create subtasks.

inwardIssue.fields.issuetype.untranslatedName?

optional untranslatedName?: string;

inwardIssue.fields.issueType?

optional issueType?: object;

Index Signature

[key: string]: unknown

inwardIssue.fields.issueType.avatarId?

optional avatarId?: number;

The ID of the issue type's avatar.

inwardIssue.fields.issueType.description?

optional description?: string;

The description of the issue type.

inwardIssue.fields.issueType.entityId?

optional entityId?: string;

Unique ID for next-gen projects.

inwardIssue.fields.issueType.hierarchyLevel?

optional hierarchyLevel?: number;

Hierarchy level of the issue type.

inwardIssue.fields.issueType.iconUrl?

optional iconUrl?: string;

The URL of the issue type's avatar.

inwardIssue.fields.issueType.id?

optional id?: string;

The ID of the issue type.

inwardIssue.fields.issueType.name?

optional name?: string;

The name of the issue type.

inwardIssue.fields.issueType.scope?

optional scope?: object;

Index Signature

[key: string]: unknown

inwardIssue.fields.issueType.scope.project?

optional project?: ... | ...;

inwardIssue.fields.issueType.scope.type?

optional type?: ... | ... | ... | ...;

The type of scope.

inwardIssue.fields.issueType.self?

optional self?: string;

The URL of these issue type details.

inwardIssue.fields.issueType.subtask?

optional subtask?: boolean;

Whether this issue type is used to create subtasks.

inwardIssue.fields.issueType.untranslatedName?

optional untranslatedName?: string;

inwardIssue.fields.priority?

optional priority?: object;

Index Signature

[key: string]: unknown

inwardIssue.fields.priority.avatarId?

optional avatarId?: number;

The avatarId of the avatar for the issue priority. This parameter is nullable and when set, this avatar references the universal avatar APIs.

inwardIssue.fields.priority.description?

optional description?: string;

The description of the issue priority.

inwardIssue.fields.priority.iconUrl?

optional iconUrl?: string;

The URL of the icon for the issue priority.

inwardIssue.fields.priority.id?

optional id?: string;

The ID of the issue priority.

inwardIssue.fields.priority.isDefault?

optional isDefault?: boolean;

Whether this priority is the default.

inwardIssue.fields.priority.name?

optional name?: string;

The name of the issue priority.

inwardIssue.fields.priority.schemes?

optional schemes?: object;

Index Signature

[key: string]: unknown

inwardIssue.fields.priority.schemes.maxResults?

optional maxResults?: ... | ...;

inwardIssue.fields.priority.schemes.startAt?

optional startAt?: ... | ...;

inwardIssue.fields.priority.schemes.total?

optional total?: ... | ...;

inwardIssue.fields.priority.self?

optional self?: string;

The URL of the issue priority.

inwardIssue.fields.priority.statusColor?

optional statusColor?: string;

The color used to indicate the issue priority.

inwardIssue.fields.status?

optional status?: object;

Index Signature

[key: string]: unknown

inwardIssue.fields.status.description?

optional description?: string;

The description of the status.

inwardIssue.fields.status.iconUrl?

optional iconUrl?: string;

The URL of the icon used to represent the status.

inwardIssue.fields.status.id?

optional id?: string;

The ID of the status.

inwardIssue.fields.status.name?

optional name?: string;

The name of the status.

inwardIssue.fields.status.scope?

optional scope?: object;

Index Signature

[key: string]: unknown

inwardIssue.fields.status.scope.project?

optional project?: ... | ...;

inwardIssue.fields.status.scope.type?

optional type?: ... | ... | ... | ...;

The type of scope.

inwardIssue.fields.status.self?

optional self?: string;

The URL of the status.

inwardIssue.fields.status.statusCategory?

optional statusCategory?: object;

Index Signature

[key: string]: unknown

inwardIssue.fields.status.statusCategory.colorName?

optional colorName?: ... | ...;

The name of the color used to represent the status category.

inwardIssue.fields.status.statusCategory.id?

optional id?: ... | ...;

The ID of the status category.

inwardIssue.fields.status.statusCategory.key?

optional key?: ... | ...;

The key of the status category.

inwardIssue.fields.status.statusCategory.name?

optional name?: ... | ...;

The name of the status category.

inwardIssue.fields.status.statusCategory.self?

optional self?: ... | ...;

The URL of the status category.

inwardIssue.fields.status.untranslatedName?

optional untranslatedName?: string;

inwardIssue.fields.summary?

optional summary?: string;

The summary description of the linked issue.

inwardIssue.fields.timetracking?

optional timetracking?: object;

Index Signature

[key: string]: unknown

inwardIssue.fields.timetracking.originalEstimate?

optional originalEstimate?: string;

The original estimate of time needed for this issue in readable format.

inwardIssue.fields.timetracking.originalEstimateSeconds?

optional originalEstimateSeconds?: number;

The original estimate of time needed for this issue in seconds.

inwardIssue.fields.timetracking.remainingEstimate?

optional remainingEstimate?: string;

The remaining estimate of time needed for this issue in readable format.

inwardIssue.fields.timetracking.remainingEstimateSeconds?

optional remainingEstimateSeconds?: number;

The remaining estimate of time needed for this issue in seconds.

inwardIssue.fields.timetracking.timeSpent?

optional timeSpent?: string;

Time worked on this issue in readable format.

inwardIssue.fields.timetracking.timeSpentSeconds?

optional timeSpentSeconds?: number;

Time worked on this issue in seconds.

inwardIssue.id?

optional id?: string;

The ID of an issue. Required if key isn't provided.

inwardIssue.key?

optional key?: string;

The key of an issue. Required if id isn't provided.

inwardIssue.self?

optional self?: string;

The URL of the issue.

outwardIssue?

optional outwardIssue?: object;

Index Signature

[key: string]: unknown

outwardIssue.fields?

optional fields?: object;

Index Signature

[key: string]: unknown

outwardIssue.fields.assignee?

optional assignee?: object;

Index Signature

[key: string]: unknown

outwardIssue.fields.assignee.accountId?

optional accountId?: string;

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

outwardIssue.fields.assignee.accountType?

optional accountType?: string;

The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)

outwardIssue.fields.assignee.active?

optional active?: boolean;

Whether the user is active.

outwardIssue.fields.assignee.avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: string]: unknown

outwardIssue.fields.assignee.avatarUrls.16x16?

optional 16x16?: ... | ...;

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

outwardIssue.fields.assignee.avatarUrls.24x24?

optional 24x24?: ... | ...;

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

outwardIssue.fields.assignee.avatarUrls.32x32?

optional 32x32?: ... | ...;

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

outwardIssue.fields.assignee.avatarUrls.48x48?

optional 48x48?: ... | ...;

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

outwardIssue.fields.assignee.displayName?

optional displayName?: string;

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

outwardIssue.fields.assignee.emailAddress?

optional emailAddress?: string;

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

outwardIssue.fields.assignee.self?

optional self?: string;

The URL of the user.

outwardIssue.fields.assignee.timeZone?

optional timeZone?: string;

The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.

outwardIssue.fields.issuetype?

optional issuetype?: object;

The type of the linked issue.

Index Signature

[key: string]: unknown

outwardIssue.fields.issuetype.avatarId?

optional avatarId?: number;

The ID of the issue type's avatar.

outwardIssue.fields.issuetype.description?

optional description?: string;

The description of the issue type.

outwardIssue.fields.issuetype.entityId?

optional entityId?: string;

Unique ID for next-gen projects.

outwardIssue.fields.issuetype.hierarchyLevel?

optional hierarchyLevel?: number;

Hierarchy level of the issue type.

outwardIssue.fields.issuetype.iconUrl?

optional iconUrl?: string;

The URL of the issue type's avatar.

outwardIssue.fields.issuetype.id?

optional id?: string;

The ID of the issue type.

outwardIssue.fields.issuetype.name?

optional name?: string;

The name of the issue type.

outwardIssue.fields.issuetype.scope?

optional scope?: object;

Index Signature

[key: string]: unknown

outwardIssue.fields.issuetype.scope.project?

optional project?: ... | ...;

outwardIssue.fields.issuetype.scope.type?

optional type?: ... | ... | ... | ...;

The type of scope.

outwardIssue.fields.issuetype.self?

optional self?: string;

The URL of these issue type details.

outwardIssue.fields.issuetype.subtask?

optional subtask?: boolean;

Whether this issue type is used to create subtasks.

outwardIssue.fields.issuetype.untranslatedName?

optional untranslatedName?: string;

outwardIssue.fields.issueType?

optional issueType?: object;

Index Signature

[key: string]: unknown

outwardIssue.fields.issueType.avatarId?

optional avatarId?: number;

The ID of the issue type's avatar.

outwardIssue.fields.issueType.description?

optional description?: string;

The description of the issue type.

outwardIssue.fields.issueType.entityId?

optional entityId?: string;

Unique ID for next-gen projects.

outwardIssue.fields.issueType.hierarchyLevel?

optional hierarchyLevel?: number;

Hierarchy level of the issue type.

outwardIssue.fields.issueType.iconUrl?

optional iconUrl?: string;

The URL of the issue type's avatar.

outwardIssue.fields.issueType.id?

optional id?: string;

The ID of the issue type.

outwardIssue.fields.issueType.name?

optional name?: string;

The name of the issue type.

outwardIssue.fields.issueType.scope?

optional scope?: object;

Index Signature

[key: string]: unknown

outwardIssue.fields.issueType.scope.project?

optional project?: ... | ...;

outwardIssue.fields.issueType.scope.type?

optional type?: ... | ... | ... | ...;

The type of scope.

outwardIssue.fields.issueType.self?

optional self?: string;

The URL of these issue type details.

outwardIssue.fields.issueType.subtask?

optional subtask?: boolean;

Whether this issue type is used to create subtasks.

outwardIssue.fields.issueType.untranslatedName?

optional untranslatedName?: string;

outwardIssue.fields.priority?

optional priority?: object;

Index Signature

[key: string]: unknown

outwardIssue.fields.priority.avatarId?

optional avatarId?: number;

The avatarId of the avatar for the issue priority. This parameter is nullable and when set, this avatar references the universal avatar APIs.

outwardIssue.fields.priority.description?

optional description?: string;

The description of the issue priority.

outwardIssue.fields.priority.iconUrl?

optional iconUrl?: string;

The URL of the icon for the issue priority.

outwardIssue.fields.priority.id?

optional id?: string;

The ID of the issue priority.

outwardIssue.fields.priority.isDefault?

optional isDefault?: boolean;

Whether this priority is the default.

outwardIssue.fields.priority.name?

optional name?: string;

The name of the issue priority.

outwardIssue.fields.priority.schemes?

optional schemes?: object;

Index Signature

[key: string]: unknown

outwardIssue.fields.priority.schemes.maxResults?

optional maxResults?: ... | ...;

outwardIssue.fields.priority.schemes.startAt?

optional startAt?: ... | ...;

outwardIssue.fields.priority.schemes.total?

optional total?: ... | ...;

outwardIssue.fields.priority.self?

optional self?: string;

The URL of the issue priority.

outwardIssue.fields.priority.statusColor?

optional statusColor?: string;

The color used to indicate the issue priority.

outwardIssue.fields.status?

optional status?: object;

Index Signature

[key: string]: unknown

outwardIssue.fields.status.description?

optional description?: string;

The description of the status.

outwardIssue.fields.status.iconUrl?

optional iconUrl?: string;

The URL of the icon used to represent the status.

outwardIssue.fields.status.id?

optional id?: string;

The ID of the status.

outwardIssue.fields.status.name?

optional name?: string;

The name of the status.

outwardIssue.fields.status.scope?

optional scope?: object;

Index Signature

[key: string]: unknown

outwardIssue.fields.status.scope.project?

optional project?: ... | ...;

outwardIssue.fields.status.scope.type?

optional type?: ... | ... | ... | ...;

The type of scope.

outwardIssue.fields.status.self?

optional self?: string;

The URL of the status.

outwardIssue.fields.status.statusCategory?

optional statusCategory?: object;

Index Signature

[key: string]: unknown

outwardIssue.fields.status.statusCategory.colorName?

optional colorName?: ... | ...;

The name of the color used to represent the status category.

outwardIssue.fields.status.statusCategory.id?

optional id?: ... | ...;

The ID of the status category.

outwardIssue.fields.status.statusCategory.key?

optional key?: ... | ...;

The key of the status category.

outwardIssue.fields.status.statusCategory.name?

optional name?: ... | ...;

The name of the status category.

outwardIssue.fields.status.statusCategory.self?

optional self?: ... | ...;

The URL of the status category.

outwardIssue.fields.status.untranslatedName?

optional untranslatedName?: string;

outwardIssue.fields.summary?

optional summary?: string;

The summary description of the linked issue.

outwardIssue.fields.timetracking?

optional timetracking?: object;

Index Signature

[key: string]: unknown

outwardIssue.fields.timetracking.originalEstimate?

optional originalEstimate?: string;

The original estimate of time needed for this issue in readable format.

outwardIssue.fields.timetracking.originalEstimateSeconds?

optional originalEstimateSeconds?: number;

The original estimate of time needed for this issue in seconds.

outwardIssue.fields.timetracking.remainingEstimate?

optional remainingEstimate?: string;

The remaining estimate of time needed for this issue in readable format.

outwardIssue.fields.timetracking.remainingEstimateSeconds?

optional remainingEstimateSeconds?: number;

The remaining estimate of time needed for this issue in seconds.

outwardIssue.fields.timetracking.timeSpent?

optional timeSpent?: string;

Time worked on this issue in readable format.

outwardIssue.fields.timetracking.timeSpentSeconds?

optional timeSpentSeconds?: number;

Time worked on this issue in seconds.

outwardIssue.id?

optional id?: string;

The ID of an issue. Required if key isn't provided.

outwardIssue.key?

optional key?: string;

The key of an issue. Required if id isn't provided.

outwardIssue.self?

optional self?: string;

The URL of the issue.

self?

optional self?: string;

The URL of the issue link.

type?

optional type?: object;

Index Signature

[key: string]: unknown

type.id?

optional id?: string;

The ID of the issue link type and is used as follows:

• In the issueLink resource it is the type of issue link. Required on create when name isn't provided. Otherwise, read only.
• In the issueLinkType resource it is read only.

type.inward?

optional inward?: string;

The description of the issue link type inward link and is used as follows:

• In the issueLink resource it is read only.
• In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.

type.name?

optional name?: string;

The name of the issue link type and is used as follows:

• In the issueLink resource it is the type of issue link. Required on create when id isn't provided. Otherwise, read only.
• In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.

type.outward?

optional outward?: string;

The description of the issue link type outward link and is used as follows:

• In the issueLink resource it is read only.
• In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.

type.self?

optional self?: string;

The URL of the issue link type. Read only.

---

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

---

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: IssueLinkWebhookEvent;

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

The event, and the field to switch on.

Overrides

WebhookPayloadBase.webhookEvent