module WorkOS::AuditTrail

The Audit Trail module provides convenience methods for working with the WorkOS Audit Trail platform. You'll need a valid API key.

@see docs.workos.com/audit-trail/overview

Public Class Methods

create_event(event:, idempotency_key: nil) click to toggle source
# File lib/workos/audit_trail.rb, line 51
def create_event(event:, idempotency_key: nil)
  request = post_request(
    path: '/events',
    auth: true,
    idempotency_key: idempotency_key,
    body: event,
  )

  execute_request(request: request)
end
get_events(options = {}) click to toggle source
# File lib/workos/audit_trail.rb, line 98
def get_events(options = {})
  response = execute_request(
    request: get_request(
      path: '/events',
      auth: true,
      params: options,
    ),
  )

  JSON.parse(response.body)['data']
end