Event Records

An EventRecord is a durable event emitted by Files.com for routing through Event Channels.

List Event Records

SDK Method

files_sdk.event_record.list()

Return Object

ListObj[EventRecord]

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

import files_sdk

try:
  event_records = files_sdk.event_record.list()
  for event_record in event_records.auto_paging_iter():
    # Operate on event_record
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Show Event Record

SDK Method

files_sdk.event_record.find()

Return Object

EventRecord

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
id
int64
Required		Event Record ID.

Example Request

import files_sdk

try:
  event_record = files_sdk.event_record.find(id)
  # Operate on event_record
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

The EventRecord Object

Some of the methods above return a EventRecord object. The attributes of this object are listed below.

AttributeDescription
id
int64		Event Record ID
workspace_id
int64		Workspace ID. 0 means the default workspace or site-wide.
event_uuid
string		Stable event UUID.
event_type
string		Versioned event type string.
severity
string		Event severity.
Possible values: info, warning, error, critical
source_type
string		Source record type.
source_id
int64		Source record ID.
occurred_at
date-time		Event occurrence date/time.
human_title
string		Human-readable event title.
human_summary
string		Human-readable event summary.
human_fields
array(object)		Human-readable event detail fields.
actor
object		Actor associated with the event.
resources
array(object)		Resources associated with the event.
payload
object		Event payload.
created_at
date-time		Event Record create date/time.