Interface: IssueWebhookPayload
Defined in: src/webhooks/payloads.ts:67
An issue was created, edited or deleted.
The one payload Atlassian documents, and the shape a real delivery was observed to have.
Extends
Properties
changelog?
optional changelog?: object;Defined in: src/webhooks/payloads.ts:84
What changed. Present on an update, absent on a creation that changed nothing.
Index Signature
[key: string]: unknownauthor?
optional author?: object;Index Signature
[key: string]: unknownauthor.accountId?
optional accountId?: string;The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
author.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)
author.active?
optional active?: boolean;Whether the user is active.
author.avatarUrls?
optional avatarUrls?: object;Index Signature
[key: string]: unknownauthor.avatarUrls.16x16?
optional 16x16?: string;The URL of the item's 16x16 pixel avatar.
author.avatarUrls.24x24?
optional 24x24?: string;The URL of the item's 24x24 pixel avatar.
author.avatarUrls.32x32?
optional 32x32?: string;The URL of the item's 32x32 pixel avatar.
author.avatarUrls.48x48?
optional 48x48?: string;The URL of the item's 48x48 pixel avatar.
author.displayName?
optional displayName?: string;The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
author.emailAddress?
optional emailAddress?: string;The email address of the user. Depending on the user’s privacy settings, this may be returned as null.
author.self?
optional self?: string;The URL of the user.
author.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.
created?
optional created?: Date;The date on which the change took place.
historyMetadata?
optional historyMetadata?: object;Index Signature
[key: string]: unknownhistoryMetadata.activityDescription?
optional activityDescription?: string;The activity described in the history record.
historyMetadata.activityDescriptionKey?
optional activityDescriptionKey?: string;The key of the activity described in the history record.
historyMetadata.actor?
optional actor?: object;Index Signature
[key: string]: unknownhistoryMetadata.actor.avatarUrl?
optional avatarUrl?: string;The URL to an avatar for the user or system associated with a history record.
historyMetadata.actor.displayName?
optional displayName?: string;The display name of the user or system associated with a history record.
historyMetadata.actor.displayNameKey?
optional displayNameKey?: string;The key of the display name of the user or system associated with a history record.
historyMetadata.actor.id?
optional id?: string;The ID of the user or system associated with a history record.
historyMetadata.actor.type?
optional type?: string;The type of the user or system associated with a history record.
historyMetadata.actor.url?
optional url?: string;The URL of the user or system associated with a history record.
historyMetadata.cause?
optional cause?: object;Index Signature
[key: string]: unknownhistoryMetadata.cause.avatarUrl?
optional avatarUrl?: string;The URL to an avatar for the user or system associated with a history record.
historyMetadata.cause.displayName?
optional displayName?: string;The display name of the user or system associated with a history record.
historyMetadata.cause.displayNameKey?
optional displayNameKey?: string;The key of the display name of the user or system associated with a history record.
historyMetadata.cause.id?
optional id?: string;The ID of the user or system associated with a history record.
historyMetadata.cause.type?
optional type?: string;The type of the user or system associated with a history record.
historyMetadata.cause.url?
optional url?: string;The URL of the user or system associated with a history record.
historyMetadata.description?
optional description?: string;The description of the history record.
historyMetadata.descriptionKey?
optional descriptionKey?: string;The description key of the history record.
historyMetadata.emailDescription?
optional emailDescription?: string;The description of the email address associated the history record.
historyMetadata.emailDescriptionKey?
optional emailDescriptionKey?: string;The description key of the email address associated the history record.
historyMetadata.extraData?
optional extraData?: Record<string, string>;Additional arbitrary information about the history record.
historyMetadata.generator?
optional generator?: object;Index Signature
[key: string]: unknownhistoryMetadata.generator.avatarUrl?
optional avatarUrl?: string;The URL to an avatar for the user or system associated with a history record.
historyMetadata.generator.displayName?
optional displayName?: string;The display name of the user or system associated with a history record.
historyMetadata.generator.displayNameKey?
optional displayNameKey?: string;The key of the display name of the user or system associated with a history record.
historyMetadata.generator.id?
optional id?: string;The ID of the user or system associated with a history record.
historyMetadata.generator.type?
optional type?: string;The type of the user or system associated with a history record.
historyMetadata.generator.url?
optional url?: string;The URL of the user or system associated with a history record.
historyMetadata.type?
optional type?: string;The type of the history record.
id?
optional id?: string;The ID of the changelog.
items?
optional items?: object[];The list of items changed.
Index Signature
[key: string]: unknowncomment?
optional comment?: object;Defined in: src/webhooks/payloads.ts:87
The comment, when the update was someone commenting.
Index Signature
[key: string]: unknownauthor?
optional author?: object;Index Signature
[key: string]: unknownauthor.accountId?
optional accountId?: string;The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
author.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)
author.active?
optional active?: boolean;Whether the user is active.
author.avatarUrls?
optional avatarUrls?: object;Index Signature
[key: string]: unknownauthor.avatarUrls.16x16?
optional 16x16?: string;The URL of the item's 16x16 pixel avatar.
author.avatarUrls.24x24?
optional 24x24?: string;The URL of the item's 24x24 pixel avatar.
author.avatarUrls.32x32?
optional 32x32?: string;The URL of the item's 32x32 pixel avatar.
author.avatarUrls.48x48?
optional 48x48?: string;The URL of the item's 48x48 pixel avatar.
author.displayName?
optional displayName?: string;The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
author.emailAddress?
optional emailAddress?: string;The email address of the user. Depending on the user’s privacy settings, this may be returned as null.
author.self?
optional self?: string;The URL of the user.
author.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.
body?
optional body?: object;The comment text in Atlassian Document Format.
Index Signature
[key: string]: unknownbody.content
content: Record<string, any>[];body.type
type: string & object | "doc";body.version
version: number;created?
optional created?: Date;The date and time at which the comment was created.
id?
optional id?: string;The ID of the comment.
jsdAuthorCanSeeRequest?
optional jsdAuthorCanSeeRequest?: boolean;Whether the comment was added from an email sent by a person who is not part of the issue. See Allow external emails to be added as comments on issuesfor information on setting up this feature.
jsdPublic?
optional jsdPublic?: boolean;Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API Create request comment operation.
properties?
optional properties?: object[];A list of comment properties. Optional on create and update.
Index Signature
[key: string]: unknownrenderedBody?
optional renderedBody?: string;The rendered version of the comment.
self?
optional self?: string;The URL of the comment.
updateAuthor?
optional updateAuthor?: object;Index Signature
[key: string]: unknownupdateAuthor.accountId?
optional accountId?: string;The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
updateAuthor.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)
updateAuthor.active?
optional active?: boolean;Whether the user is active.
updateAuthor.avatarUrls?
optional avatarUrls?: object;Index Signature
[key: string]: unknownupdateAuthor.avatarUrls.16x16?
optional 16x16?: string;The URL of the item's 16x16 pixel avatar.
updateAuthor.avatarUrls.24x24?
optional 24x24?: string;The URL of the item's 24x24 pixel avatar.
updateAuthor.avatarUrls.32x32?
optional 32x32?: string;The URL of the item's 32x32 pixel avatar.
updateAuthor.avatarUrls.48x48?
optional 48x48?: string;The URL of the item's 48x48 pixel avatar.
updateAuthor.displayName?
optional displayName?: string;The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
updateAuthor.emailAddress?
optional emailAddress?: string;The email address of the user. Depending on the user’s privacy settings, this may be returned as null.
updateAuthor.self?
optional self?: string;The URL of the user.
updateAuthor.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.
updated?
optional updated?: Date;The date and time at which the comment was updated last.
visibility?
optional visibility?: object;Index Signature
[key: string]: unknownvisibility.identifier?
optional identifier?: string | null;The ID of the group or the name of the role that visibility of this item is restricted to.
visibility.type?
optional type?: "role" | "group" | string & object;Whether visibility of this item is restricted to a group or role.
visibility.value?
optional value?: string;The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use identifier.
issue
issue: Issue;Defined in: src/webhooks/payloads.ts:78
The issue as it stands after the change. On a deletion, as it stood before.
issue_event_type_name
issue_event_type_name: string;Defined in: src/webhooks/payloads.ts:75
Jira's own name for what happened, finer than webhookEvent: an edit, a comment and a transition all arrive as jira:issue_updated and are told apart only here. Typed as the string it is rather than as a union, because an administrator can add issue events to a site and the set is therefore not closed.
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
user?
optional user?: object;Defined in: src/webhooks/payloads.ts:81
Who caused it. Optional because nothing guarantees an actor — a scheduled change has none to name.
Index Signature
[key: string]: unknownaccountId?
optional accountId?: string;The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
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)
active?
optional active?: boolean;Whether the user is active.
avatarUrls?
optional avatarUrls?: object;Index Signature
[key: string]: unknownavatarUrls.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.
displayName?
optional displayName?: string;The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
emailAddress?
optional emailAddress?: string;The email address of the user. Depending on the user’s privacy settings, this may be returned as null.
self?
optional self?: string;The URL of the user.
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.
webhookEvent
webhookEvent: IssueWebhookEvent;Defined in: src/webhooks/payloads.ts:68
The event, and the field to switch on.