jira.js
    Preparing search index...

    Function getEventById

    • Returns information about a single event by ID.

      Authorization scopes required: read:events:admin

      Parameters

      • client: Client
      • parameters: { eventId: string; orgId: string }
        • eventId: string

          ID of the event to return

        • orgId: string

          Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              data?: {
                  attributes: {
                      action: string;
                      actor: {
                          app?: {
                              attributes?: Record<string, any>;
                              id: string;
                              type?: string;
                              [key: string]: unknown;
                          };
                          auth?: {
                              authType: | string & {}
                              | "container-token"
                              | "api-token"
                              | "connect-token"
                              | "auth-token-for-2LO"
                              | "auth-token-for-3LO";
                              tokenId?: string;
                              tokenLabel?: string;
                              [key: string]: unknown;
                          };
                          email?: string;
                          id: string;
                          links?: { self: string
                          | null; [key: string]: unknown };
                          name?: string;
                          onBehalfOf?: {
                              email?: string;
                              id: string;
                              name?: string;
                              [key: string]: unknown;
                          };
                          [key: string]: unknown;
                      };
                      container?: {
                          attributes?: Record<string, any>;
                          id: string;
                          links?:
                              | {
                                  alt?: (...)
                                  | (...);
                                  self?: (...) | (...) | (...);
                                  [key: string]: unknown;
                              }
                              | { alt: string; [key: string]: unknown };
                          type?: string;
                          [key: string]: unknown;
                      }[];
                      context: {
                          attributes?: Record<string, any>;
                          id: string;
                          links?:
                              | { alt?: string; self?: string
                              | null; [key: string]: unknown }
                              | { alt: string; [key: string]: unknown };
                          type?: string;
                          [key: string]: unknown;
                      }[];
                      location?: {
                          city?: string;
                          countryName?: string;
                          geo?: string;
                          ip?: string;
                          regionName?: string;
                          [key: string]: unknown;
                      };
                      time: Date;
                      [key: string]: unknown;
                  };
                  id: string;
                  links: { self: string
                  | null; [key: string]: unknown };
                  message?: { content?: string; format?: string; [key: string]: unknown };
                  type: string & {} | "events";
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >