Interface: CommentWebhookPayload

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

A comment was added, edited or removed.

Undocumented as a payload of its own — comment and issue are named after the entities the event concerns. Note that a comment on an issue also raises jira:issue_updated, which is documented and carries the comment.

Extends

• WebhookPayloadBase

Properties

comment?

optional comment?: object;

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

Index Signature

[key: string]: unknown

author?

optional author?: object;

Index Signature

[key: string]: unknown

author.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]: unknown

author.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]: unknown

body.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]: unknown

renderedBody?

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]: unknown

updateAuthor.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]: unknown

updateAuthor.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]: unknown

visibility.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?

optional issue?: Issue;

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

---

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

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

The event, and the field to switch on.

Overrides

WebhookPayloadBase.webhookEvent