Cased is a developer and API first product. After accessing your Cased dashboard you'll follow these steps to publish your first audit trail events. From there you can create a comprehensive audit trail and take advantage of more advanced functionality.
Create an audit trail. Cased provides you with a default audit trail named after your organization, but you can create as many audit trails as you need.
For an application, we recommend starting with a single audit trail and naming it after the application that will publish events to that audit trail, e.g.
By default, each organization also starts with an audit trail called
system that automatically records administrative actions taken on a Cased account (e.g.
Publish events to Cased. You will need the
PUBLISH_API_KEY for the audit trail you created in step 1. You can then configure one of the Cased clients or integrations to publish events from your application. Alternatively you can publish events directly using the REST API.
Retrieve audit trail events. You will need to create a Cased Policy, which governs what information can be retrieved from an audit trail. For example, you may want to create a policy that does not expose Personally Identifable Information (PII). Each policy comes with a
POLICY_API_KEY, which can be used with one of the Cased clients or integrations to retrieve audit trail data. Alternatively you can use the REST API to retrieve audit trail data.
For more detailed guidance on using Cased, explore our guides.
Learn how to easily send audit events to Cased, how to use API keys to authenticate your publish requests, and how to work with our test and live environments.
Fetch, search, and list audit trail data—and build audit trails for your own customers.
Audit trails in Cased answer the who, what, when, where, and why. While Cased will accept any shape of event you send us, it's important to consider a few guidelines when designing your events.