How to setup Natural HR and TeamTailor integration
Natural HR integrates with TeamTailor to allow you to move candidates from TeamTailor into Natural HR automatically which have been hired in TeamTailor.
This removes both the time and error potential of having to do this manually.
The setup of the integration takes place in both systems. We are NOT able to give any support on using TeamTailor but have provided basic guidance below on how to get the integration working.
Integration fields
The integration will synchronise the following fields:
- First name
- Last name
- Home telephone number
- Home email address
- Job role §
- Department §
- Location / site §
- Candidate documents
- If CV/resume is included this will be imported and stored along with the other documents
- TeamTailor API does not support accessing "offer" details - this means we cannot programatically access information stored in the offer hence, if the below fields are required, these need to be setup as custom fields in TeamTailor:
- Candidate address (this will be imported as a single line)
- Candidate salary (this can only be setup as a numeric field so cannot contain text like Per annum etc)
- Candidate start date
Fields marked § must have the EXACT same values in both systems to synchronise - for example, if you have a job in Natural HR called Senior sales manager but it is called Senior sale manager in TeamTailor then it will not synchronise.
TeamTailor setup
- To setup the integration you need to go to Settings/Integrations
- You will need to be an administrator user to be able to do this
- Select API Keys in the left menu and then click the button top right for "New API Key"
- Give a name to the key and then select Admin under API scope
- This should then select Read by default - if not selected then ensure Read is ticked
- Write access is NOT needed for this integration so does not need to be selected
- This will then generate an API key which you will need below to link the two systems
- Additionally, you should also note down your TeamTailor client ID - for example, if your TeamTailor URL is https://app.teamtailor.com/companies/ABCDEFG/dashboard then your client ID is ABCDEFG
- You will need the client ID and API key to be able to setup the Natural HR element in the next section below
Additionally you will need to enable the integration in the TeamTailor marketplace - to do this go to Settings -> Integrations -> Marketplace activations. You will then see an option to go to the Marketplace.
When this loads, you can either just search for Natural HR or use the filters - when you find Natural HR click this and in the popup that appears click on Activate at the top right corner.
You will then see Natural HR listed in your Marketplace activations.
Natural HR setup
- To setup the integration you need to go to Admin/Company/Settings/Tokens and click on Add
- You will need to be an administrator user to be able to do this
- Enter a meaningful name for the integration - e.g. TeamTailor
- Choose TeamTailor from the integration list
- Enter the client ID and API key taken from TeamTailor (see above)
- If you want to use the custom fields, you should enter the API field name from custom fields in TeamTailor - you should enter this EXACTLY as it exists in TeamTailor
- For example, in the below the field name is candidate-start-date-field and this is what should be entered in the start date box in the integration setup
- Now click on submit to confirm the setup
Using the integration
- There are a number of ways this integration can be called from TeamTailor - we are NOT able to give support on setting up TeamTailor
- The easiest way to use this is to link the integration to a stage in TeamTailor
- This means that once someone is moved into that stage, the integration will fire automatically
- To do this, you can either select Stages when adding a new role or click to the role in question where you can see all the stages listed
- At the top right of the screen click in Triggers
- When the next screen loads, find the stage / stages you wish this integration to trigger from - under the relevant stage, click on Add trigger and then "Send Natural HR webhook"
- On the popup that appears you just need to click on Add trigger
- This will then add the trigger under the stage as per below image - now any time a candidate is moved into that stage, it will trigger the web hook which sends the information to Natural HR to convert the candidate to an employee
- You should take care not to set the webhook to trigger multiple times within your workflow or to move a candidate to the stage where the integration is setup more than once or this will result in a duplicate employee record being added in Natural HR
Comments
0 comments
Please sign in to leave a comment.