WorkOS Docs Homepage
Integrations

Breathe HR

Learn about syncing your user list with Breathe HR.

This guide outlines how to synchronize your application’s Breathe HR directories.

To synchronize an Enterprise’s users and groups provisioned for your application, you’ll need the following information from the Enterprise:

  • Breathe HR API key

The Enterprise will need to create an API key for you. An API key can be generated from the Admin Settings menu.

A screenshot showing where to select "Settings" in the Breathe HR dashboard.

Under "Integrations", select "API Setup".

A screenshot showing where to select "API Setup" in the Breathe HR dashboard settings.

Next, select "Enable API".

A screenshot showing where to select "Enable API" on the "API Setup" page in the Breathe HR dashboard.

Verify that you’d like to enable the API to access user information.

A screenshot showing to mark the checkbox denoting "I understand and want to continue" in the "Warning" modal in the Breathe HR dashboard.

Save the production API key – this will be used in the next step.

A screenshot showing where to select the production API key in the "API Setup" section of the Breathe HR dashboard.

Login to your WorkOS dashboard and select “Organizations” from the left hand Navigation bar

Select the Organization you’d like to enable a Breathe HR Directory Sync connection for.

On the Organization’s page click “Add Directory”.

A screenshot showing where to select "Add Directory" in the WorkOS dashboard.

Select “Breathe HR” as the Directory Provider, and then provide a descriptive name for the connection. Select “Create Directory”.

A screenshot showing the configuration of the "Create Directory" modal to create a Breathe HR Directory in the WorkOS dashboard.

Click “Update Directory” on the Directory details page.

A screenshot showing where to select "Update Directory" in the WorkOS dashboard.

Input the Breathe HR API key and click “Save Directory Details”.

A screenshot showing the input of the Breathe HR API key into the "Directory Details" modal in the WorkOS dashboard.

Now, you should see users and groups synced over from Breathe HR.

Departments from Breathe HR are synced as groups in WorkOS. All users are synced, but only those marked as “Current employee” or "Pending leaver" are active.

A screenshot showing a successfully linked Breathe HR Directory in the WorkOS dashboard.

How often do Breathe HR directories perform a sync?

Breathe HR directories poll every 30 minutes starting from the time of the initial sync.