jira.js
    Preparing search index...

    Interface SprintWebhookPayload

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

    interface SprintWebhookPayload {
        matchedWebhookIds?: number[];
        sprint?: {
            completeDate?: Date;
            createdDate?: Date;
            endDate?: Date;
            goal?: string;
            id?: number;
            name?: string;
            originBoardId?: number;
            self?: string;
            startDate?: Date;
            state: "active" | "closed" | string & {} | "future";
            [key: string]: unknown;
        };
        timestamp: number;
        webhookEvent: SprintWebhookEvent;
    }

    Hierarchy (View Summary)

    Index
    matchedWebhookIds? sprint? timestamp webhookEvent
    matchedWebhookIds?: number[]

    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.

    sprint?: {
        completeDate?: Date;
        createdDate?: Date;
        endDate?: Date;
        goal?: string;
        id?: number;
        name?: string;
        originBoardId?: number;
        self?: string;
        startDate?: Date;
        state: "active" | "closed" | string & {} | "future";
        [key: string]: unknown;
    }
    timestamp: number

    When Jira raised the event, in milliseconds since the epoch.

    webhookEvent: SprintWebhookEvent

    The event, and the field to switch on.

    Settings
    Member Visibility

    On This Page
    Properties