Audit Log Event

An Audit Log Event represents a notable action taken within your application. Each event captures what happened, who did it, what was affected, and contextual information about when and where it occurred.

Create an Audit Log Event.

This API supports idempotency which guarantees that performing the same operation multiple times will have the same result as if the operation were performed only once. This is handy in situations where you may need to retry a request due to a failure or prevent accidental duplicate requests from creating more than one resource.

To achieve idempotency, you can add Idempotency-Key request header to a Create Event request with a unique string as the value. Each subsequent request matching this unique string will return the same response. We suggest using v4 UUIDs for idempotency keys to avoid collisions.

Idempotency keys expire after 24 hours. The API will generate a new response if you submit a request with an expired key.

import { WorkOS } from '@workos-inc/node';

const workos = new WorkOS('sk_example_123456789');

await workos.auditLogs.createEvent(
  'org_01EHWNCE74X7JSDV0X3SZ3KJNY',
  {
    action: 'user.signed_in',
    occurredAt: new Date(),
    version: 1,
    actor: {
      type: 'user',
      id: 'user_TF4C5938',
      name: 'Jon Smith',
      metadata: {
        role: 'admin',
      },
    },
    targets: [
      {
        type: 'user',
        id: 'user_98432YHF',
        name: 'Jon Smith',
      },
      {
        type: 'team',
        id: 'team_J8YASKA2',
        metadata: {
          owner: 'user_01GBTCQ2',
        },
      },
    ],
    context: {
      location: '1.1.1.1',
      userAgent: 'Chrome/104.0.0.0',
    },
    metadata: {
      extra: 'data',
    },
  },
  {
    idempotencyKey: '884793cd-bef4-46cf-8790-ed49257a09c6',
  },
);