Interface: UserWebhookPayload

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

A user was created, edited or deleted. Undocumented; user 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

---

timestamp

timestamp: number;

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

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

Inherited from

WebhookPayloadBase.timestamp

---

user?

optional user?: object;

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

Index Signature

[key: string]: unknown

accountId?

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

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

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

The event, and the field to switch on.

Overrides

WebhookPayloadBase.webhookEvent