Getting Started with Trailbase

1Install the SDK

Install the Trailbase SDK using your preferred package manager:

npm install @trailbase/sdk

Also available with yarn add @trailbase/sdk or pnpm add @trailbase/sdk

2Get Your API Key

After signing up, navigate to your dashboard:

1. Go to Settings in the left sidebar
2. Click API Keys tab
3. Click Generate New API Key
4. Copy the key (it won't be shown again!)
5. Store it securely in your environment variables

3Send Your First Event

Initialize the client and log your first audit event:

import { TrailbaseClient } from '@trailbase/sdk';

// Initialize the client
const trailbase = new TrailbaseClient({
  apiKey: process.env.TRAILBASE_API_KEY!,
  tenantId: 'your-tenant-id',
});

// Log an audit event
await trailbase.log({
  action: 'user.login',
  actor: {
    id: 'user_123',
    email: 'alice@acme.com',
    ip: '192.168.1.1',
  },
  resource: {
    type: 'session',
    id: 'session_xyz',
  },
  outcome: 'success',
  metadata: {
    login_method: 'password',
    mfa_enabled: true,
  },
});

console.log('✓ Audit event logged successfully!');

Expected Output

✓ Audit event logged successfully!

4View in Dashboard

Your event will appear in the Trailbase dashboard within seconds:

1. Navigate to Audit Logs in your dashboard
2. You should see the user.login event
3. Click on the event to view full details, including metadata and hash chain verification

The event includes a cryptographic hash linking it to the previous event, ensuring immutability.

5Next Steps

Now that you've logged your first event, explore these topics: