Interface: BoardWebhookPayload

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

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

Extends

• WebhookPayloadBase

Properties

board?

optional board?: object;

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

Index Signature

[key: string]: unknown

admins?

optional admins?: object;

The users and groups who own the board.

Index Signature

[key: string]: unknown

admins.groups?

optional groups?: object[];

Index Signature

[key: string]: unknown

admins.users?

optional users?: object[];

Index Signature

[key: string]: unknown

canEdit?

optional canEdit?: boolean;

Whether the board can be edited.

favourite?

optional favourite?: boolean;

Whether the board is selected as a favorite.

id?

optional id?: number;

The ID of the board.

isPrivate?

optional isPrivate?: boolean;

Whether the board is private.

location?

optional location?: object;

The container that the board is located in.

Index Signature

[key: string]: unknown

location.avatarURI?

optional avatarURI?: string;

location.displayName?

optional displayName?: string;

location.name?

optional name?: string;

location.projectId?

optional projectId?: number;

location.projectKey?

optional projectKey?: string;

location.projectName?

optional projectName?: string;

location.projectTypeKey?

optional projectTypeKey?: string;

location.userAccountId?

optional userAccountId?: string;

location.userId?

optional userId?: number;

name?

optional name?: string;

The name of the board.

self?

optional self?: string;

The URL of the board.

type?

optional type?: string & object | "simple" | "scrum" | "kanban";

The type the board.

---

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

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

The event, and the field to switch on.

Overrides

WebhookPayloadBase.webhookEvent