Interface: WorklogWebhookPayload

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

Work was logged, edited or removed. Undocumented; worklog is named after the entity, not from a specification.

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

---

webhookEvent

webhookEvent: WorklogWebhookEvent;

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

The event, and the field to switch on.

Overrides

WebhookPayloadBase.webhookEvent

---

worklog?

optional worklog?: object;

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

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.

comment?

optional comment?: object;

A comment about the worklog in Atlassian Document Format. Optional when creating or updating a worklog.

Index Signature

[key: string]: unknown

comment.content

content: Record<string, any>[];

comment.type

type: string & object | "doc";

comment.version

version: number;

created?

optional created?: Date;

The datetime on which the worklog was created.

id?

optional id?: string;

The ID of the worklog record.

issueId?

optional issueId?: string;

The ID of the issue this worklog is for.

properties?

optional properties?: object[];

Details of properties for the worklog. Optional when creating or updating a worklog.

Index Signature

[key: string]: unknown

self?

optional self?: string;

The URL of the worklog item.

started?

optional started?: Date;

The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.

timeSpent?

optional timeSpent?: string;

The time spent working on the issue as days (#d), hours (#h), or minutes (#m or #). Required when creating a worklog if timeSpentSeconds isn't provided. Optional when updating a worklog. Cannot be provided if timeSpentSecond is provided.

timeSpentSeconds?

optional timeSpentSeconds?: number;

The time in seconds spent working on the issue. Required when creating a worklog if timeSpent isn't provided. Optional when updating a worklog. Cannot be provided if timeSpent is provided.

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 datetime on which the worklog was last updated.

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.