WorkOS Docs Homepage
Events
API referenceDashboardSign In

Stream events to Datadog

Stream and analyze WorkOS activity in Datadog.

WorkOS Datadog dashboard showing various metrics and graphs describing authentication events and user activity

WorkOS supports real-time streaming of events to Datadog. By analyzing WorkOS activity directly in Datadog, you are able to:

  • View trends in user sign-ins, user growth, new SSO connections and more.
  • Debug customer issues related to sign-in, email verification, password resets and more.
  • Generate reports of user activity per customer organization.
  • Set alerts for unexpected activity, such as sudden spike in failed password attempts.

See all of the WorkOS events that stream to Datadog in the event types documentation.

Introduction

Setting up real-time streaming of WorkOS events to Datadog only takes a few minutes and can be done in three simple steps.

1. Create a Datadog API key

First, create a new Datadog API key to give WorkOS permission to send event activity as logs to your Datadog account. While you can use an existing API key, WorkOS recommends creating a new key that will only be used for WorkOS event streaming.

  1. Sign in to your Datadog account.
  2. Navigate to the Organization Settings → API Keys page.
  3. Choose the New Key button
  4. Enter a name for your new API key.
  5. Choose the Create Key button.
    A screenshot showing how to create an API key in the Datadog dashboard.

2. Configure event streaming in WorkOS

The next step is to configure event streaming in the WorkOS Dashboard using the Datadog API key that was created in the previous step.

  1. Sign in to the WorkOS Dashboard.
  2. Navigate to the Events page.
  3. Choose the Stream to Datadog button.
A screenshot showing how setup streaming events to Datadog in the WorkOS Dashboard.
  1. Enter the Datadog API key.
  2. Select your Datadog region.
  3. Choose the Save Log Stream Details button.
A screenshot showing how to enter a Datadog API key in WorkOS Dashboard.

With event streaming configured, when new events occur, WorkOS will send the events to Datadog with the source workos.

3. Add the WorkOS Datadog dashboard

The final step is to add the WorkOS Datadog dashboard to your Datadog account.

  1. Sign in to your Datadog account.
  2. Navigate to the Dashboard List page.
  3. Choose the + New Dashboard button.
A screenshot showing how to create a new dashboard in Datadog.
  1. Enter a dashboard name.
  2. Choose the New Dashboard button.
  3. In the new dashboard, choose the Configure button.
  4. Download the WorkOS Datadog dashboard JSON file
  5. Scroll down in the context menu and choose Import dashboard JSON.
  6. Upload the WorkOS Datadog dashboard JSON file downloaded in the previous step.
A screenshot showing how to import a JSON definition of a Dashboard into Datadog.