jira.js
    Preparing search index...

    Interface UserWebhookPayload

    A user was created, edited or deleted. Undocumented; user is named after the entity.

    interface UserWebhookPayload {
        matchedWebhookIds?: number[];
        timestamp: number;
        user?: {
            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;
        };
        webhookEvent: UserWebhookEvent;
    }

    Hierarchy (View Summary)

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

    user?: {
        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;
    }

    Type Declaration

    • [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.

    webhookEvent: UserWebhookEvent

    The event, and the field to switch on.

    Settings
    Member Visibility

    On This Page
    Properties