Skip to content

Interface: AttachmentWebhookPayload ​

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

A file was attached or removed. Undocumented; attachment is named after the entity.

Extends ​

Properties ​

attachment? ​

ts
optional attachment?: object;

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

Index Signature ​

ts
[key: string]: unknown

author? ​

ts
optional author?: object;
Index Signature ​
ts
[key: string]: unknown
author.accountId? ​
ts
optional accountId?: string;

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

author.accountType? ​
ts
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? ​
ts
optional active?: boolean;

Whether the user is active.

author.avatarUrls? ​
ts
optional avatarUrls?: object;
Index Signature ​
ts
[key: string]: unknown
author.avatarUrls.16x16? ​
ts
optional 16x16?: string;

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

author.avatarUrls.24x24? ​
ts
optional 24x24?: string;

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

author.avatarUrls.32x32? ​
ts
optional 32x32?: string;

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

author.avatarUrls.48x48? ​
ts
optional 48x48?: string;

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

author.displayName? ​
ts
optional displayName?: string;

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

author.emailAddress? ​
ts
optional emailAddress?: string;

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

author.self? ​
ts
optional self?: string;

The URL of the user.

author.timeZone? ​
ts
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.

content? ​

ts
optional content?: string;

The content of the attachment.

created? ​

ts
optional created?: Date;

The datetime the attachment was created.

filename? ​

ts
optional filename?: string;

The file name of the attachment.

id? ​

ts
optional id?: string;

The ID of the attachment.

mimeType? ​

ts
optional mimeType?: string;

The MIME type of the attachment.

self? ​

ts
optional self?: string;

The URL of the attachment details response.

size? ​

ts
optional size?: number;

The size of the attachment.

thumbnail? ​

ts
optional thumbnail?: string;

The URL of a thumbnail representing the attachment.


matchedWebhookIds? ​

ts
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 ​

ts
timestamp: number;

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

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

Inherited from ​

WebhookPayloadBase.timestamp


webhookEvent ​

ts
webhookEvent: AttachmentWebhookEvent;

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

The event, and the field to switch on.

Overrides ​

WebhookPayloadBase.webhookEvent