Skip to content

HR Data Definition (Personio API Integration)

In this step, you will choose the type of report to generate, attributes to process and the polling interval for your Personio integration.

You can also apply custom filters on the report data. Personio supports both Full Report Extract and Delta Extract.

Full Load

If you have selected Full Load then a full report for all the selected attributes from the employee attributes will be generated. This report will be generated on the basis of type of polling interval selected.

Personio Full Load

Figure 1. Personio full load.


For polling, you can refer to Personio polling.

Delta Load

If you have selected Delta Load then whenever there is any update or change in any of the attributes, it will be fetched and processed within the selected time interval.

Personio API Delta Load

Figure 2. Personio API delta load.

If you are choosing Update or Leave lifecycle, it is recommended to configure Periodic Full Sync.

Periodic Full Sync

You can enable Periodic full sync within the delta load settings, allowing Hire2Retire to periodically sync all HR updates.

Initial one-time full sync

You can select the Initial one-time full sync checkbox if you want to receive an initial pull of the full report as soon as the flow is deployed.

Personio Initial Pull

Figure 3. Personio initial pull.

Select employee attributes you want to process

You can select the employee attributes defined in the Personio that you want to be processed by Hire2Retire. Hire2Retire pre-selects some of the important attributes from the HR system. Pre-selected attributes can be removed by you if you don't want them to be included in the report.

Personio Employee Attributes

Figure 4. Personio employee attributes.


And, if you have enabled 'Future Hire, Rehire and Termination' on Application page then following fields will appear such as (Date Format and Time Zone).

Select Date Format

Select the date format of the HR attributes that are of date type. The default date format is YYYY-MM-DD.

Details of Date Format

Figure 5. Details of Date Format


Select Time Zone

Choose the time zone in which you want to process the scheduled hire, rehire and termination events.

Single time zone

All the scheduled hire, rehire and termination events will be executed in a selected time zone. The default time zone is America/New York.

Details of Single Time Zone

Figure 6. Details of single time zone


Multiple time zone

Here, scheduled onboarding and offboarding records will be executed in the time zone based on the condition defined by HR data. For eg. An organization can have multiple offices at different locations (time zones) for which they can select respective time zones according to their locations.

Details of Multiple Time Zone

Figure 7. Details of multiple time zone


Apply Selection Criterias

Hire2Retire enables you to process specific events and filter out the rest by defining filter criteria. On clicking the Apply Filter button, you will be able to set up conditions using employee attributes. Only employees whose attributes match the conditions will be processed. You can create complex filters using AND or OR conditions.

Event Filtering for Personio Data

Figure 8. Event filtering for Personio data in Future Hire, Rehire and Termaination.