jira.js
    Preparing search index...

    Interface VersionWebhookPayload

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

    interface VersionWebhookPayload {
        matchedWebhookIds?: number[];
        timestamp: number;
        version?: {
            approvers?: {
                accountId?: string;
                declineReason?: string;
                description?: string;
                status?: string;
                [key: string]: unknown;
            }[];
            archived?: boolean;
            description?: string;
            driver?: string;
            expand?: string;
            id?: string;
            issuesStatusForFixVersion?: {
                done?: number;
                inProgress?: number;
                toDo?: number;
                unmapped?: number;
                [key: string]: unknown;
            };
            moveUnfixedIssuesTo?: string;
            name?: string;
            operations?: {
                href?: string;
                iconClass?: string;
                id?: string;
                label?: string;
                styleClass?: string;
                title?: string;
                weight?: number;
                [key: string]: unknown;
            }[];
            overdue?: boolean;
            projectId?: number;
            released?: boolean;
            releaseDate?: string;
            self?: string;
            startDate?: string;
            userReleaseDate?: string;
            userStartDate?: string;
            [key: string]: unknown;
        };
        webhookEvent: VersionWebhookEvent;
    }

    Hierarchy (View Summary)

    Index
    matchedWebhookIds? timestamp version? 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.

    timestamp: number

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

    version?: {
        approvers?: {
            accountId?: string;
            declineReason?: string;
            description?: string;
            status?: string;
            [key: string]: unknown;
        }[];
        archived?: boolean;
        description?: string;
        driver?: string;
        expand?: string;
        id?: string;
        issuesStatusForFixVersion?: {
            done?: number;
            inProgress?: number;
            toDo?: number;
            unmapped?: number;
            [key: string]: unknown;
        };
        moveUnfixedIssuesTo?: string;
        name?: string;
        operations?: {
            href?: string;
            iconClass?: string;
            id?: string;
            label?: string;
            styleClass?: string;
            title?: string;
            weight?: number;
            [key: string]: unknown;
        }[];
        overdue?: boolean;
        projectId?: number;
        released?: boolean;
        releaseDate?: string;
        self?: string;
        startDate?: string;
        userReleaseDate?: string;
        userStartDate?: string;
        [key: string]: unknown;
    }

    Type Declaration

    • [key: string]: unknown
    • Optionalapprovers?: {
          accountId?: string;
          declineReason?: string;
          description?: string;
          status?: string;
          [key: string]: unknown;
      }[]

      If the expand option approvers is used, returns a list containing the approvers for this version.

    • Optionalarchived?: boolean

      Indicates that the version is archived. Optional when creating or updating a version.

    • Optionaldescription?: string

      The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes.

    • Optionaldriver?: string

      The Atlassian account ID of the version driver. Optional when creating or updating a version. If the expand option driver is used, returns the Atlassian account ID of the driver.

    • Optionalexpand?: string

      Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:

      • operations Returns the list of operations available for this version.
      • issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done.
      • driver Returns the Atlassian account ID of the version driver.
      • approvers Returns a list containing approvers for this version.

      Optional for create and update.

    • Optionalid?: string

      The ID of the version.

    • OptionalissuesStatusForFixVersion?: {
          done?: number;
          inProgress?: number;
          toDo?: number;
          unmapped?: number;
          [key: string]: unknown;
      }
      • Optionaldone?: number

        Count of issues with status done.

      • OptionalinProgress?: number

        Count of issues with status in progress.

      • OptionaltoDo?: number

        Count of issues with status to do.

      • Optionalunmapped?: number

        Count of issues with a status other than to do, in progress, and done.

    • OptionalmoveUnfixedIssuesTo?: string

      The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.

    • Optionalname?: string

      The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.

    • Optionaloperations?: {
          href?: string;
          iconClass?: string;
          id?: string;
          label?: string;
          styleClass?: string;
          title?: string;
          weight?: number;
          [key: string]: unknown;
      }[]

      If the expand option operations is used, returns the list of operations available for this version.

    • Optionaloverdue?: boolean

      Indicates that the version is overdue.

    • OptionalprojectId?: number

      The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.

    • Optionalreleased?: boolean

      Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.

    • OptionalreleaseDate?: string

      The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

    • Optionalself?: string

      The URL of the version.

    • OptionalstartDate?: string

      The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

    • OptionaluserReleaseDate?: string

      The date on which work on this version is expected to finish, expressed in the instance's Day/Month/Year Format date format.

    • OptionaluserStartDate?: string

      The date on which work on this version is expected to start, expressed in the instance's Day/Month/Year Format date format.

    webhookEvent: VersionWebhookEvent

    The event, and the field to switch on.

    Settings
    Member Visibility

    On This Page
    Properties