Beyond Connection Flow: Setup Flow. Let your users configure their integration.
BETA: While our filtering feature is extensively used in production, the self-serve field mapping feature is newly added and currently in BETA.
Our connection flow allows your customers to configure and validate their credentials so we can sync data. For deeper integrations, additional configuration steps are often required, such as mapping custom fields not covered by our model or specifying filters to limit shared data. These setup steps can now be offered in a self-serve manner to your customers via our Setup Flow.
To enable the Setup Flow for new integrations:
Alternatively, you can enable filtering by providing the enable_filtering
parameter in the Create Connection Link endpoint. Note that field mapping is not yet available via API; it will be available once it exits BETA.
To enable the Setup Flow for existing integrations:
Alternatively, you can create a setup link for filtering using the Create Provisioning Link endpoint.
Currently, we only offer filtering via API. Once field mapping is out of BETA, other steps will be available via API as well.
The Field Mapping step allows users to configure custom fields:
Data filtering is an HRIS-specific feature that allows you or your users to choose which employees to include in the data sync.
We plan to add more steps to the self-serve flow in the future. If you have any feedback or feature requests, please let us know.
Currently, we are working on the following steps:
Beyond Connection Flow: Setup Flow. Let your users configure their integration.
BETA: While our filtering feature is extensively used in production, the self-serve field mapping feature is newly added and currently in BETA.
Our connection flow allows your customers to configure and validate their credentials so we can sync data. For deeper integrations, additional configuration steps are often required, such as mapping custom fields not covered by our model or specifying filters to limit shared data. These setup steps can now be offered in a self-serve manner to your customers via our Setup Flow.
To enable the Setup Flow for new integrations:
Alternatively, you can enable filtering by providing the enable_filtering
parameter in the Create Connection Link endpoint. Note that field mapping is not yet available via API; it will be available once it exits BETA.
To enable the Setup Flow for existing integrations:
Alternatively, you can create a setup link for filtering using the Create Provisioning Link endpoint.
Currently, we only offer filtering via API. Once field mapping is out of BETA, other steps will be available via API as well.
The Field Mapping step allows users to configure custom fields:
Data filtering is an HRIS-specific feature that allows you or your users to choose which employees to include in the data sync.
We plan to add more steps to the self-serve flow in the future. If you have any feedback or feature requests, please let us know.
Currently, we are working on the following steps: