Interface: FilterWebhookPayload

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

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

Extends

• WebhookPayloadBase

Properties

filter?

optional filter?: object;

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

Index Signature

[key: string]: unknown

approximateLastUsed?

optional approximateLastUsed?: Date;

[Experimental] Approximate last used time. Returns the date and time when the filter was last used. Returns null if the filter hasn't been used after tracking was enabled. For performance reasons, timestamps aren't updated in real time and therefore may not be exactly accurate.

description?

optional description?: string;

A description of the filter.

editPermissions?

optional editPermissions?: object[];

The groups and projects that can edit the filter.

Index Signature

[key: string]: unknown

favourite?

optional favourite?: boolean;

Whether the filter is selected as a favorite.

favouritedCount?

optional favouritedCount?: number;

The count of how many users have selected this filter as a favorite, including the filter owner.

id?

optional id?: string;

The unique identifier for the filter.

isWritable?

optional isWritable?: boolean;

jql?

optional jql?: string;

The JQL query for the filter. For example, project = SSP AND issuetype = Bug.

name

name: string;

The name of the filter. Must be unique.

owner?

optional owner?: object;

Index Signature

[key: string]: unknown

owner.accountId?

optional accountId?: string;

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.

owner.accountType?

optional accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";

The user account type. Can take the following values:

• atlassian regular Atlassian user account
• app system account used for Connect applications and OAuth to represent external systems
• customer Jira Service Desk account representing an external service desk

owner.active?

optional active?: boolean;

Whether the user is active.

owner.applicationRoles?

optional applicationRoles?: object;

Index Signature

[key: string]: unknown

owner.applicationRoles.callback?

optional callback?: object;

Index Signature

[key: string]: unknown

owner.applicationRoles.items?

optional items?: object[];

Index Signature

[key: string]: unknown

owner.applicationRoles.max-results?

optional max-results?: number;

owner.applicationRoles.pagingCallback?

optional pagingCallback?: object;

Index Signature

[key: string]: unknown

owner.applicationRoles.size?

optional size?: number;

owner.appType?

optional appType?: string;

The app type of the user account when accountType is 'app'. Can take the following values:

• service Service Account
• agent Rovo Agent Account
• unknown Unknown app type

owner.avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: string]: unknown

owner.avatarUrls.16x16?

optional 16x16?: string;

The URL of the item's 16x16 pixel avatar.

owner.avatarUrls.24x24?

optional 24x24?: string;

The URL of the item's 24x24 pixel avatar.

owner.avatarUrls.32x32?

optional 32x32?: string;

The URL of the item's 32x32 pixel avatar.

owner.avatarUrls.48x48?

optional 48x48?: string;

The URL of the item's 48x48 pixel avatar.

owner.displayName?

optional displayName?: string;

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

owner.emailAddress?

optional emailAddress?: string;

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

owner.expand?

optional expand?: string;

Expand options that include additional user details in the response.

owner.groups?

optional groups?: object;

Index Signature

[key: string]: unknown

owner.groups.callback?

optional callback?: object;

Index Signature

[key: string]: unknown

owner.groups.items?

optional items?: object[];

Index Signature

[key: string]: unknown

owner.groups.max-results?

optional max-results?: number;

owner.groups.pagingCallback?

optional pagingCallback?: object;

Index Signature

[key: string]: unknown

owner.groups.size?

optional size?: number;

owner.guest?

optional guest?: boolean;

Whether the user is a guest.

owner.locale?

optional locale?: string;

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

owner.self?

optional self?: string;

The URL of the user.

owner.timeZone?

optional timeZone?: string;

The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned.

searchUrl?

optional searchUrl?: string;

A URL to view the filter results in Jira, using the Search for issues using JQL operation with the filter's JQL string to return the filter results. For example, _https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug_.

self?

optional self?: string;

The URL of the filter.

sharedUsers?

optional sharedUsers?: object;

Index Signature

[key: string]: unknown

sharedUsers.end-index?

optional end-index?: number;

The index of the last item returned on the page.

sharedUsers.items?

optional items?: object[];

The list of items.

Index Signature

[key: string]: unknown

sharedUsers.max-results?

optional max-results?: number;

The maximum number of results that could be on the page.

sharedUsers.size?

optional size?: number;

The number of items on the page.

sharedUsers.start-index?

optional start-index?: number;

The index of the first item returned on the page.

sharePermissions?

optional sharePermissions?: object[];

The groups and projects that the filter is shared with.

Index Signature

[key: string]: unknown

subscriptions?

optional subscriptions?: object;

Index Signature

[key: string]: unknown

subscriptions.end-index?

optional end-index?: number;

The index of the last item returned on the page.

subscriptions.items?

optional items?: object[];

The list of items.

Index Signature

[key: string]: unknown

subscriptions.max-results?

optional max-results?: number;

The maximum number of results that could be on the page.

subscriptions.size?

optional size?: number;

The number of items on the page.

subscriptions.start-index?

optional start-index?: number;

The index of the first item returned on the page.

viewUrl?

optional viewUrl?: string;

A URL to view the filter results in Jira, using the ID of the filter. For example, _https://your-domain.atlassian.net/issues/?filter=10100_.

---

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

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

The event, and the field to switch on.

Overrides

WebhookPayloadBase.webhookEvent