Function: getEventById()

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

Defined in: src/admin/api/events.ts:94

Returns information about a single event by ID.

Scopes

Authorization scopes required: read:events:admin

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ eventId: string; orgId: string; }	-
parameters.eventId	string	ID of the event to return
parameters.orgId?	string	Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?	RequestOptions	-

Returns

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