> For the complete documentation index, see [llms.txt](https://docs.stitchflow.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stitchflow.io/documentation/integrations/workos.md).

# WorkOS

## Overview

Use the WorkOS integration to identify problems with your users and licenses before they occur. Integrating with WorkOS enables you to build boards that correlate fields within WorkOS and with other connected tools.

#### Generating API key

1. **Log in** to your [**WorkOS account**](https://signin.workos.com/).
2. Go to **API Keys** in the dashboard.
3. Click **Create New API Key**.
4. Name the API Key and set permissions.
5. Click **Create**.

## Configure

Enable the WorkOS integration from `Connections` in the left sidenav. Click `Connect` and enter your Client ID, Client Secret, and Enterprise ID. Before connecting, WorkOS will sync for a few minutes while fetching data. Once connected, you can click the `...` menu on the WorkOS integration tile to manage or disconnect the integration. 

## Data model

We automatically fetch and relate the following objects from WorkOS.

<details>

<summary>Supported objects</summary>

* Users

</details>

We support the following actions in WorkOS.

<details>

<summary>Supported actions</summary>

* None

</details>

## Boards

When building a board, you can select any supported WorkOS resource as your object to indicate the data you want to surface on your board. We automatically determine the primary field for each object. The primary field is meant to be a unique representation of each record in a board.&#x20;

{% hint style="info" %}
An object in Stitchflow is a data type that is used to treat several different pieces of data as one unit.
{% endhint %}

### Adding fields

Click `Add field` to select fields from both within WorkOS and across your other connected tools. We only show fields that can be joined with your chosen object.&#x20;

### Triggering actions

Click `Integration actions` in the top right of any board to view all available actions across your connected integrations. When selecting an action, you'll be prompted to fill out all required inputs necessary to run the action. Changes and updates made via actions will persist to all boards.

{% hint style="info" %}
Stitchflow fetches WorkOS data every 24 hours.
{% endhint %}