Prerequisites
- Your company needs to be on the "Custom Pro Plan" of BreezyHR for the BreezyHR API to be enabled. This is the 'Enterprise'/custom plan of BreezyHR and you likely have a custom pricing setup with BreezyHR. Please contact support@breezyhr.com or your account manager to enable API access if you are already on the "Custom Pro Plan".
- You need to be an Admin in BreezyHR. If you are not an Admin, please reach out to your Administrator or IT department.
- You know you are an Admin if you can see your Company Settings as indicated below after clicking the cog in the top left corner.
- Recommended: Create a new user in your company in the following format:
integration-{customer_name}@{your_company_domain.com} (e.g., integration-abc@acme.com)
This account will be used below for your integration access with BreezyHR.
We recommend this approach to ensure continuity: if the admin is set for the BreezyHR login and this person either leaves the company or is removed as an admin, then the connection will fail!
Instructions
BreezyHR uses your own Login information for integrations. For reliability, we highly recommend creating a new user in Breezy that will be used for this integration. Make sure the created user is an Admin.
- Log into BreezyHR, then click on the cog in the top left corner, then on "Invite Members"
- Click on "Invite Members":
- Enter the name of an email you wish to use for the integration user, set their role to "Administrator" and press "Invite User(s)":
- Finally, verify the email of the user you just created, then enter their email address and password into the connection flow: