Skip to main content
Beta. The Event Logs API is available under /v0/event-logs while Traversal collects feedback. The endpoint may change before it stabilizes at /v1. Contact your Traversal point of contact before you rely on it for production workloads.
The Event Logs API lists audit events for your organization, such as integrations created, users invited, sessions started, and sign-ins and sign-outs. All endpoints require authentication. Create an API key first. For the base URL, error envelope, and generic status codes, see the API overview. The sidebar lists every endpoint, generated from the OpenAPI spec.

Required roles

Event Logs requires the admin role. A request from a key without it returns 403 Forbidden.

Event shape

Every event log row has the same envelope:

The type field

type identifies the event and determines the shape of data. The API reference lists every value. In brief: New (resource, action) pairs may be added over time. Clients should handle unknown type values without failing.

The data field

data carries one of two shapes depending on the action:
  • Lifecycle events (everything except .update): data is a snapshot of the resource at the time of the event. The exact fields vary by type.
  • .update events: data is a diff: a map of field names to { "old": <previous>, "new": <current> }. Only fields that actually changed are present.

Example: lifecycle event

Example: update event

Check type first to know which data shape to expect.

Filtering

The list endpoint supports three optional filters: Combine them in one request. For example, ?type=auth.login&start_time=2026-05-01T00:00:00Z&end_time=2026-06-01T00:00:00Z returns the logins during May 2026.

Pagination

Pagination uses the page and limit query parameters. The response includes count, prev, next, and total. limit is capped at 100.
If both page and limit are omitted, all matching rows are returned in a single response. Results are ordered newest-first by id. To ingest events into a SIEM, poll with start_time set to the timestamp of the most recent event you ingested. Single-tenant SaaS and BYOC deployments use their own API URL. See the API overview.

Rate limits

The endpoint is limited to 100 requests per minute. Hitting the limit returns 429 Too Many Requests with a Retry-After header. Wait that many seconds, then retry.

Errors

In addition to the generic status codes, the Event Logs API returns: