Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

event_id

string<uuid>

required

The ID of the event.

Response

The requested Event.

Event Object

Description

The Event object is used to represent an event.

Usage Example

Fetch from the LIST Events endpoint.

event_id

string<uuid>

required

The ID of the event.

Example:

"1b978423-db0a-4037-a4cf-f79c60cb67b3"

actor_user_id

string<uuid>

required

The ID of the actor user.

Example:

"29827fb8-f2dd-4e80-9576-28e31e9934ac"

actor_name

string<string>

required

The name of the actor user.

Example:

"John Smith"

event_type

string

required

The event type.

Example:

"USERS_CREATED"

created_at

string<date-time>

required

The day and time the event was created.

Example:

"2022-01-23T04:56:07.000Z"

actor_email

string

The email of the actor user.

Example:

"john@acmecorp.com"

actor_ip_address

string

The IP address of the event actor.

Example:

"255.255.255.0"

api_token_name

string

The name of the API token used to create the event.

Example:

"My API Token"

api_token_preview

string

The preview of the API token used to create the event.

Example:

"**************************M_g=="

sub_events

object[]

Show child attributes