Note: Only Super Admins can manage integrations in CharlieHR.
We understand that you may want to integrate your own system, or a platform you don't see listed on the Integrations page, with Charlie - there are a couple of ways you could do this:
Generating API keys via our V3 model
This will allow you to choose from a wide list of endpoints that can sync to your chosen platform:
Head to Company>Integrations on the left of Charlie and choose the API Keys tab at the top of the page
Scroll to the V3 section and click to Generate Keys - give this a clear title (perhaps the name of the system in question)
Choose whether the access should be Super Admin view (to include data like salaries) or Admin view (no salaries will be included in the data share)
Choose either read only or read and write (for now, all integrations will be read only, but watch this space...)
Copy your Client ID and your Client Secret - as the text says, these will not be stored in Charlie for you and if they are not stored externally, you will not have access to them
You will see that you have access to our API documentation on this page, and you are shown whether that API key is being used. You can also revoke this integration here too, if required (note, this is a hard deletion, meaning no historical data is saved).
Using one of our partnered third-party unified API providers
We partner with providers such as Merge, Kombo, APIDeck, Truto, and Knit and you're able to use our V1 option to work in this way:
Head to Company>Integrations and choose the API Key tab at the top of the page
Confirm that you're ready to save the keys, and Charlie will generate them for you
Copy the ID and Secret and store them both externally - as stated, Charlie will not store these for you meaning if you don't keep them saved externally, you will not have access to them
Integrating Charlie with listed platforms
There are some platforms listed on our Company>Integrations page that need to be integrated using our V1 option - you will be prompted to use this option when clicking on their dedicated tile. Read more about this here.
V1 - this option should be used to integrate with the systems listed on our API Keys page, or to integrate with one of our third-party providers, like Merge (as an example). You will be prompted to use this option when you click through to this page after selecting the platform you'd like to integrate with.
V3 - this option should be used to integrate with systems that are not listed on our API Keys page, including your own. This option includes detailed documentation regarding all endpoints and customisations that can be made.