By setting up the integration between Personio and YourCampus you will achieve following:
All the existing (active) employees in your Personio account will be added to YourCampus
Any future mutations in Personio (activation or deactivation of employees) will automatically be synced with YourCampus on a daily basis.
Setting up the integration consists of the following steps:
Creating an API key in Personio
Sharing the API Client ID and Secret with YourCampus support
YourCampus activates the integration.
Optional: If you would like to selectively sync employees, this can be achieved by adding a custom attribute in Personio to indicate if an employee is eligible for YourCampus or not. These additional optional steps are described at the bottom of this article.
Step 1: Creating a Personio API Key for Integration
The following instructions will show you how to create a new API key in order to set up an integration with YourCampus:
Log in to Personio as an administrator
Go to the Settings -> Integrations -> API Credentials section
Click on “Generate new credential”
Input a Name for the integration such as “YourCampus API Key”
Select Other in the Integration field
Click the checkbox for Read for the Employees personal data row
For the Readable employee attributes select the following fields:
Birthday
Email
First Name
Last Name
Status
Hire Date
Termination Date
Department
Click on “Generate new credential”
Step 2: Sharing the credentials with YourCampus
Share this (Client ID and Secret) via an encrypted secret sharing service (1password, onetimesecret.com, etc) with your Customer Success Representative at YourCampus.
Step 3: Activation of the integration
As soon as the integration is activated, YourCampus support will inform you of this.
Optional: Selective syncing of employees
If you would like to selectively sync employees, this can be achieved by adding a custom attribute in Personio to indicate if an employee is eligible for YourCampus or not. Complete the steps below to set this up:
Adding the custom field
Navigate to Settings -> Integrations -> Employee Information
Add a new field, preferably in the HR Information tab as seen in the image below:
In the “Name of your attribute” field type “YourCampus”
In the “What type of attribute is it?” dropdown, select the “List of options” type
Add “Yes” and “No” as options:
Setting the custom field in the User Profile
Set the default answer to “No”, so employees will not be synced unless specified so in the Personio User Profile section:
Returning the attribute with the API
In order for the new attribute to be used in the integration, it needs to be configured via the API: