Skip to content

Interface: SprintWebhookPayload ​

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

A sprint changed. Undocumented; sprint is named after the entity.

Extends ​

Properties ​

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


sprint? ​

ts
optional sprint?: object;

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

Index Signature ​

ts
[key: string]: unknown

completeDate? ​

ts
optional completeDate?: Date;

createdDate? ​

ts
optional createdDate?: Date;

endDate? ​

ts
optional endDate?: Date;

goal? ​

ts
optional goal?: string;

id? ​

ts
optional id?: number;

name? ​

ts
optional name?: string;

originBoardId? ​

ts
optional originBoardId?: number;

self? ​

ts
optional self?: string;

startDate? ​

ts
optional startDate?: Date;

state ​

ts
state: "active" | "closed" | string & object | "future";

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

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

The event, and the field to switch on.

Overrides ​

WebhookPayloadBase.webhookEvent