Interface: VersionWebhookPayload

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

A version changed. Undocumented; version 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

---

version?

optional version?: object;

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

Index Signature

[key: string]: unknown

approvers?

optional approvers?: object[];

If the expand option approvers is used, returns a list containing the approvers for this version.

Index Signature

[key: string]: unknown

archived?

optional archived?: boolean;

Indicates that the version is archived. Optional when creating or updating a version.

description?

optional description?: string;

The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes.

driver?

optional driver?: string;

The Atlassian account ID of the version driver. Optional when creating or updating a version. If the expand option driver is used, returns the Atlassian account ID of the driver.

expand?

optional expand?: string;

Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:

• operations Returns the list of operations available for this version.
• issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done.
• driver Returns the Atlassian account ID of the version driver.
• approvers Returns a list containing approvers for this version.

Optional for create and update.

id?

optional id?: string;

The ID of the version.

issuesStatusForFixVersion?

optional issuesStatusForFixVersion?: object;

Index Signature

[key: string]: unknown

issuesStatusForFixVersion.done?

optional done?: number;

Count of issues with status done.

issuesStatusForFixVersion.inProgress?

optional inProgress?: number;

Count of issues with status in progress.

issuesStatusForFixVersion.toDo?

optional toDo?: number;

Count of issues with status to do.

issuesStatusForFixVersion.unmapped?

optional unmapped?: number;

Count of issues with a status other than to do, in progress, and done.

moveUnfixedIssuesTo?

optional moveUnfixedIssuesTo?: string;

The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.

name?

optional name?: string;

The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.

operations?

optional operations?: object[];

If the expand option operations is used, returns the list of operations available for this version.

Index Signature

[key: string]: unknown

overdue?

optional overdue?: boolean;

Indicates that the version is overdue.

projectId?

optional projectId?: number;

The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.

released?

optional released?: boolean;

Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.

releaseDate?

optional releaseDate?: string;

The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

self?

optional self?: string;

The URL of the version.

startDate?

optional startDate?: string;

The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

userReleaseDate?

optional userReleaseDate?: string;

The date on which work on this version is expected to finish, expressed in the instance's Day/Month/Year Format date format.

userStartDate?

optional userStartDate?: string;

The date on which work on this version is expected to start, expressed in the instance's Day/Month/Year Format date format.

---

webhookEvent

webhookEvent: VersionWebhookEvent;

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

The event, and the field to switch on.

Overrides

WebhookPayloadBase.webhookEvent