Interface Webhook

A webhook.

interface Webhook {
    events: (
        | "jira:issue_created"
        | "jira:issue_updated"
        | "jira:issue_deleted"
        | "comment_created"
        | "comment_updated"
        | "comment_deleted"
        | "issue_property_set"
        | "issue_property_deleted")[];
    expirationDate?: number;
    fieldIdsFilter?: string[];
    id: number;
    issuePropertyKeysFilter?: string[];
    jqlFilter: string;
    url: string;
}

Properties

events expirationDate? fieldIdsFilter? id issuePropertyKeysFilter? jqlFilter url

Properties

events

events: (
    | "jira:issue_created"
    | "jira:issue_updated"
    | "jira:issue_deleted"
    | "comment_created"
    | "comment_updated"
    | "comment_deleted"
    | "issue_property_set"
    | "issue_property_deleted")[]

The Jira events that trigger the webhook.

OptionalexpirationDate

expirationDate?: number

The date after which the webhook is no longer sent. Use Extend webhook life to extend the date.

OptionalfieldIdsFilter

fieldIdsFilter?: string[]

A list of field IDs. When the issue changelog contains any of the fields, the webhook jira:issue_updated is sent. If this parameter is not present, the app is notified about all field updates.

id

id: number

The ID of the webhook.

OptionalissuePropertyKeysFilter

issuePropertyKeysFilter?: string[]

A list of issue property keys. A change of those issue properties triggers the issue_property_set or issue_property_deleted webhooks. If this parameter is not present, the app is notified about all issue property updates.

jqlFilter

jqlFilter: string

The JQL filter that specifies which issues the webhook is sent for.

url

url: string

The URL that specifies where the webhooks are sent.

Settings

Member Visibility

On This Page

Properties