jira.js
    Preparing search index...

    Interface WorklogWebhookPayload

    Work was logged, edited or removed. Undocumented; worklog is named after the entity, not from a specification.

    interface WorklogWebhookPayload {
        matchedWebhookIds?: number[];
        timestamp: number;
        webhookEvent: WorklogWebhookEvent;
        worklog?: {
            author?: {
                accountId?: string;
                accountType?: string;
                active?: boolean;
                avatarUrls?: {
                    "16x16"?: string;
                    "24x24"?: string;
                    "32x32"?: string;
                    "48x48"?: string;
                    [key: string]: unknown;
                };
                displayName?: string;
                emailAddress?: string;
                self?: string;
                timeZone?: string;
                [key: string]: unknown;
            };
            comment?: {
                content: Record<string, any>[];
                type: string & {} | "doc";
                version: number;
                [key: string]: unknown;
            };
            created?: Date;
            id?: string;
            issueId?: string;
            properties?: { key?: string; value?: unknown; [key: string]: unknown }[];
            self?: string;
            started?: Date;
            timeSpent?: string;
            timeSpentSeconds?: number;
            updateAuthor?: {
                accountId?: string;
                accountType?: string;
                active?: boolean;
                avatarUrls?: {
                    "16x16"?: string;
                    "24x24"?: string;
                    "32x32"?: string;
                    "48x48"?: string;
                    [key: string]: unknown;
                };
                displayName?: string;
                emailAddress?: string;
                self?: string;
                timeZone?: string;
                [key: string]: unknown;
            };
            updated?: Date;
            visibility?: {
                identifier?: string
                | null;
                type?: "role" | "group" | string & {};
                value?: string;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
    }

    Hierarchy (View Summary)

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

    webhookEvent: WorklogWebhookEvent

    The event, and the field to switch on.

    worklog?: {
        author?: {
            accountId?: string;
            accountType?: string;
            active?: boolean;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            emailAddress?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        comment?: {
            content: Record<string, any>[];
            type: string & {} | "doc";
            version: number;
            [key: string]: unknown;
        };
        created?: Date;
        id?: string;
        issueId?: string;
        properties?: { key?: string; value?: unknown; [key: string]: unknown }[];
        self?: string;
        started?: Date;
        timeSpent?: string;
        timeSpentSeconds?: number;
        updateAuthor?: {
            accountId?: string;
            accountType?: string;
            active?: boolean;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            emailAddress?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        updated?: Date;
        visibility?: {
            identifier?: string
            | null;
            type?: "role" | "group" | string & {};
            value?: string;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    }

    Type Declaration

    • [key: string]: unknown
    • Optionalauthor?: {
          accountId?: string;
          accountType?: string;
          active?: boolean;
          avatarUrls?: {
              "16x16"?: string;
              "24x24"?: string;
              "32x32"?: string;
              "48x48"?: string;
              [key: string]: unknown;
          };
          displayName?: string;
          emailAddress?: string;
          self?: string;
          timeZone?: string;
          [key: string]: unknown;
      }
      • OptionalaccountId?: string

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

      • OptionalaccountType?: string

        The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)

      • Optionalactive?: boolean

        Whether the user is active.

      • OptionalavatarUrls?: {
            "16x16"?: string;
            "24x24"?: string;
            "32x32"?: string;
            "48x48"?: string;
            [key: string]: unknown;
        }
        • Optional16x16?: string

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

        • Optional24x24?: string

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

        • Optional32x32?: string

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

        • Optional48x48?: string

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

      • OptionaldisplayName?: string

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

      • OptionalemailAddress?: string

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

      • Optionalself?: string

        The URL of the user.

      • OptionaltimeZone?: string

        The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.

    • Optionalcomment?: {
          content: Record<string, any>[];
          type: string & {} | "doc";
          version: number;
          [key: string]: unknown;
      }

      A comment about the worklog in Atlassian Document Format. Optional when creating or updating a worklog.

    • Optionalcreated?: Date

      The datetime on which the worklog was created.

    • Optionalid?: string

      The ID of the worklog record.

    • OptionalissueId?: string

      The ID of the issue this worklog is for.

    • Optionalproperties?: { key?: string; value?: unknown; [key: string]: unknown }[]

      Details of properties for the worklog. Optional when creating or updating a worklog.

    • Optionalself?: string

      The URL of the worklog item.

    • Optionalstarted?: Date

      The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.

    • OptionaltimeSpent?: string

      The time spent working on the issue as days (#d), hours (#h), or minutes (#m or #). Required when creating a worklog if timeSpentSeconds isn't provided. Optional when updating a worklog. Cannot be provided if timeSpentSecond is provided.

    • OptionaltimeSpentSeconds?: number

      The time in seconds spent working on the issue. Required when creating a worklog if timeSpent isn't provided. Optional when updating a worklog. Cannot be provided if timeSpent is provided.

    • OptionalupdateAuthor?: {
          accountId?: string;
          accountType?: string;
          active?: boolean;
          avatarUrls?: {
              "16x16"?: string;
              "24x24"?: string;
              "32x32"?: string;
              "48x48"?: string;
              [key: string]: unknown;
          };
          displayName?: string;
          emailAddress?: string;
          self?: string;
          timeZone?: string;
          [key: string]: unknown;
      }
      • OptionalaccountId?: string

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

      • OptionalaccountType?: string

        The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)

      • Optionalactive?: boolean

        Whether the user is active.

      • OptionalavatarUrls?: {
            "16x16"?: string;
            "24x24"?: string;
            "32x32"?: string;
            "48x48"?: string;
            [key: string]: unknown;
        }
        • Optional16x16?: string

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

        • Optional24x24?: string

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

        • Optional32x32?: string

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

        • Optional48x48?: string

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

      • OptionaldisplayName?: string

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

      • OptionalemailAddress?: string

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

      • Optionalself?: string

        The URL of the user.

      • OptionaltimeZone?: string

        The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.

    • Optionalupdated?: Date

      The datetime on which the worklog was last updated.

    • Optionalvisibility?: {
          identifier?: string | null;
          type?: "role" | "group" | string & {};
          value?: string;
          [key: string]: unknown;
      }
      • Optionalidentifier?: string | null

        The ID of the group or the name of the role that visibility of this item is restricted to.

      • Optionaltype?: "role" | "group" | string & {}

        Whether visibility of this item is restricted to a group or role.

      • Optionalvalue?: string

        The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use identifier.

    Settings
    Member Visibility

    On This Page
    Properties