Prerequisites
Please carefully read the following to make sure you fulfil all the requirements to set up the integration:
Your account must belong to the “HR user" organisational role in your company's Breathe HR instance.
To check this is the case for your user, follow the below instructions.
- Log into Breathe HR and click on the "Configure" tab in the top navigation bar, and then click on "Settings" in the drop-down.
- Locate the "API Setup" tab in the "Settings" page under "Integrations". If you can see this option you have the correct permissions and can continue.
If you cannot see the "API Setup" tab (or any other tabs from these intructions), it means that your account does not belong to the "HR user" role. Please reach out to your company’s Breathe HR administrator who will be able to assign you this role or alternatively complete the integration themselves.
Step by Step Instructions
Step 1 - Navigate to the Breathe HR tile in Ravio
In the Ravio onboarding flow, select the tab marked Breathe HR.
Step 2 - Locate the Production API key
Navigate to Configure > Settings and go to ‘API Setup’ in the ‘Integrations’ section of the menu.
Copy the Production API Key from the page that appears.
Please make sure that you the value that you copied is the Production API Key and NOT the Sandbox API Key.
Step 3 - Copy the Production API Key into Ravio
Paste the key into the connection flow, and then click on "Set up integration":