Jira.js - Jira Cloud API library
    Preparing search index...

    Interface Webhook

    A webhook.

    interface Webhook {
        events: string[];
        expirationDate?: number;
        fieldIdsFilter?: string[];
        id: number;
        issuePropertyKeysFilter?: string[];
        jqlFilter: string;
    }
    Index

    Properties

    events expirationDate? fieldIdsFilter? id issuePropertyKeysFilter? jqlFilter

    Properties

    events: string[]

    The Jira events that trigger the webhook.

    expirationDate?: number

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

    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: number

    The ID of the webhook.

    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: string

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

    Settings

    Member Visibility

    On This Page

    Properties