jira.js
    Preparing search index...

    Interface AttachmentWebhookPayload

    A file was attached or removed. Undocumented; attachment is named after the entity.

    interface AttachmentWebhookPayload {
        attachment?: {
            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;
            };
            content?: string;
            created?: Date;
            filename?: string;
            id?: string;
            mimeType?: string;
            self?: string;
            size?: number;
            thumbnail?: string;
            [key: string]: unknown;
        };
        matchedWebhookIds?: number[];
        timestamp: number;
        webhookEvent: AttachmentWebhookEvent;
    }

    Hierarchy (View Summary)

    Index
    attachment? matchedWebhookIds? timestamp webhookEvent
    attachment?: {
        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;
        };
        content?: string;
        created?: Date;
        filename?: string;
        id?: string;
        mimeType?: string;
        self?: string;
        size?: number;
        thumbnail?: string;
        [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.

    • Optionalcontent?: string

      The content of the attachment.

    • Optionalcreated?: Date

      The datetime the attachment was created.

    • Optionalfilename?: string

      The file name of the attachment.

    • Optionalid?: string

      The ID of the attachment.

    • OptionalmimeType?: string

      The MIME type of the attachment.

    • Optionalself?: string

      The URL of the attachment details response.

    • Optionalsize?: number

      The size of the attachment.

    • Optionalthumbnail?: string

      The URL of a thumbnail representing the attachment.

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

    The event, and the field to switch on.

    Settings
    Member Visibility

    On This Page
    Properties