Audit Trail

Dashboard Overview

Learn about using the Developer Dashboard to operate your WorkOS Audit Trail

The Developer Dashboard is a user interface for you to configure and operate your WorkOS Audit Trail. You can use it to view published audit events, monitor your API use, and manage your API key.

The Developer Dashboard is organized into multiple sections. Each section represents a particular area of functionality related to your WorkOS Audit Trail and API use.

API Key

This section of the Developer Dashboard contains your Secret Key. This API key is required to use the Audit Trail API.

To learn more about Authentication and how to use your key, consult the Authentication section of the Audit Trail REST API Reference.

Projects

Projects are a way of separating the audit trails for your different applications, services, or products.

Each WorkOS account features one Default project and one Demo project. Projects available to each WorkOS account are currently limited to the provided Default and Demo projects. If you're interested in adding more projects to your account, or migrating events between projects, please let us know.

API keys are scoped by project. Your API key will be different for each of your Default and Demo projects.

You can switch between projects using the drop-down menu at the top of your Developer Dashboard's left-hand menu.

Audit Events Viewer

The Audit Events Viewer section of the Developer Dashboard offers a high-level log and detailed information for each event you publish using the WorkOS API.

When you perform a live search of your audit events, the most recent results appear immediately.

You can use different kinds of information as search terms. Examples include name (e.g. Clarence Birdseye), email (e.g. cbirdseye@example.com), action (e.g. user.searched_audit_trail_events), or event ID (e.g. evt_01DH368X8KEG3536CNGFEA9816).

Audit Event search does not currently support search by date or time.

No additional context is required to search events. The Developer Dashboard automatically seeks and returns the most relevant events based on your query. If you require more granular control, use event filtering to narrow results by date range, event type, actor, and organization.