Personio API Integration Connection

Personio is a Human Resources (HR) software and services provider. This HR system is designed to streamline HR processes and provide a centralized platform for managing employee data and HR functions.

Create a Connection

The API integration for Personio uses the client credentials authentication method to establish a connection. Personio requires the following keys to authenticate its clients using this mechanism:

• Connection Name - A user-defined nomenclature for your connection. By default, the connection name is "Connection-OAuth Client Cred", you can change the name as per your preference.

• Client ID - This is the application Client ID to interact with Personio API. You will get the client ID created at the time of your registration on Personio portal.

• Client Secret - This is the application Client Secret to interact with Personio API. You will get the client secret created at the time of your registration on Personio portal.

Figure 1. Personio Connection Set Up page - Create Connection

Obtaining Client Credentials for Personio

• Log into your account.
• Go to Settings > Integrations > API Credentials.

Figure 2. Personio API Credentials page

• Click on Create custom integration.

Figure 3. Creating custom integration on Personio

• Enter Name of the integration and click on next.

Figure 4. Naming the custom integration

• Select the Employee read permission.

Figure 5. Setting permissions for the custom integration

• Choose the desired employee attributes for the API response. If none is selected, only the employee ID will be included. It's recommended to select "All". Click on Create Integration.

Figure 6. Selecting Employee attributes for the custom integration

• The API credentials will be generated. Copy the Client ID and Client Secret, then click Finish.

Figure 7. API Credentials

• Return to the Personio API integration connection page in your Hire2Retire account and paste these client credentials to create connection.

Configuration

Once you have successfully configured the connections, you can continue with the Design section to configure the rest of the workflow following these steps in order.

1. HR Data Definition
   • API Integration
2. Lifecycle Business Rules
3. Employment Status
4. HR to AD Profile Map
5. Organizational Unit Assignment - Only defined in on-premise Active Directory
6. Security Group Assignment
7. Distribution List Assignment

Deployment

Once your workflow has been setup, you can optionally setup notifications and archival for your workflow.

• Hire2Retire Event Notifications
• Hire2Retire Compliance and Audit Trail

Otherwise, you can proceed to deploy and test it on the Hire2Retire platform, see Deploy and Test Flow