Skip to content
Rails
Website
API Reference

Audit Events

Audit events

List audit events
GET/api/v1/audit/events
ModelsExpand Collapse
AuditEventListResponse object { data, pagination }
data: array of object { id, action, actor, 12 more }
id: string
formatuuid
action: "users.business.register" or "users.auth.login" or "users.auth.refresh" or 13 more
One of the following:
"users.business.register"
"users.auth.login"
"users.auth.refresh"
"users.auth.revoke"
"users.password_reset.request"
"users.password_reset.complete"
"users.beta.apply"
"users.api_key.create"
"users.api_key.revoke"
"accounts.account.create"
"accounts.account.update_status"
"accounts.account.close"
"accounts.money.deposit"
"accounts.money.withdraw"
"accounts.money.transfer"
"ledger.transaction.post"
actor: object { id, type, roles }
id: string
type: "user" or "api_key" or "internal_service" or "anonymous"
One of the following:
"user"
"api_key"
"internal_service"
"anonymous"
roles: optional array of string
correlation_id: string
created_at: string
formatdate-time
environment: "sandbox" or "production"
One of the following:
"sandbox"
"production"
metadata: map[string]
occurred_at: string
formatdate-time
organization_id: string
formatuuid
outcome: "success" or "client_error" or "server_error"
One of the following:
"success"
"client_error"
"server_error"
request: object { id, method, path, 2 more }
id: string
method: string
path: string
ip: optional string
user_agent: optional string
schema_version: 1
source_service: "users" or "accounts" or "ledger"
One of the following:
"users"
"accounts"
"ledger"
target: object { id, type }
id: string
type: string
reason: optional string
maxLength500