Skip to main content

How To Create A Custom Integration In Compliance

This article walks you through how to configure a custom integration for pushing user data into Compliance

Updated this week

The Custom Integrations feature allows you to automatically fetch personnel data from third-party systems and use it to create and manage users within the Compliance platform. In addition, we also allow you to connect to Microsoft Entra and SAP SuccessFactors all within the Custom Configuration section.

The integration builder lets you establish a connection to a third party API, which makes personnel management more streamlined, whether you're pulling data from an HR system or another employee database.

Navigating to the Integration Settings

To begin setting up a custom integration:

  1. Go to the Administration module in the platform.

  2. Select Integrations from the side menu.

  3. Click THIRD PARTY INTEGRATIONS > Add New Integration.

Configuring a Custom Integration

After clicking the Add New Integration tab, you will be presented with a few options for creating a custom integration.

1. Under Integration Type, choose between:

  • Custom

  • Entra

  • SuccessFactors

2. Depending on the authentication method supported by your third-party system, select an Authentication Type between:

  • Basic

  • Private Key

  • OAuth


3. Enter the fields required by your authentication type:

  • Basic: Simple authentication scheme built into the HTTP protocol. Requires Username and Password.

  • Private Key: Provide a Private Key that will be sent through the authentication header in the request as a bearer token.

  • Oauth: OAuth Client Credentials Flow will be used to request an access token, which will then be used to authenticate subsequent API requests. Included fields are:

    • Client ID

    • Client Secret

    • OAuth Token URL

    • OAUTH Token Scope

NOTE: If you are using the Entra or SuccessFactors integration, you will be using the OAuth Client Credentials Flow

Data Mappings

Once you’ve created your integration, it will appear as a tile on the Third Party Integrations page. From here, you can complete the setup by configuring Data Mappings.


Click the Configure button on your custom integration tile and scroll down to the Data Mappings Section

The left column represents standard fields in the Compliance platform. The right column is where you’ll enter the corresponding field names from your third-party system.

Required Fields

The following fields are always required:

  • Email

  • First Name

  • Last Name

Make sure each of these fields is mapped accurately to their equivalents in your source system. These fields are essential for identifying and managing users in Compliance.

Mapping Additional Fields

You can also map any additional fields that are supported for Compliance Users. These will be selectable from a dropdown menu on the left side.

To add more field mappings:

  1. Choose the Compliance fields from the dropdown (left column).

  2. Enter the matching field names from your external system (right column).

  3. If necessary, click + Add Mappings until all relevant data points are mapped.

Accuracy matters: Ensure the field names from your third-party system match exactly (including case sensitivity) to avoid data sync errors.

Scheduled Jobs

Once your data mappings are complete, the final step is to schedule the integration job that fetches and processes user data into Compliance.

To create a scheduled job:

  1. In your integration configuration, click the Scheduled Jobs tab.

  2. Click + New Scheduled Job.

Schedule Options

  • Daily

  • Weekly (Saturday Night)

  • Disabled

Processing Options

Select how incoming data should be handled:

  • Create Only: Adds new users that do not yet exist in Compliance.

    • Skip creates on terminated employees: Enabling this setting will exclude users who are marked as terminated in your source system.

  • Create and Update: Creates new and updates existing users.

    • Skip creates on terminated employees: Enabling this setting will exclude users who are marked as terminated in your source system.

    • Mark existing terminated users as inactive: Enabling this setting will mark terminated users in your source system as inactive within Compliance.

Finally, add the Custom Report URL for your source system.

Note: You can add more than one scheduled job to your integration. Simply click + New Scheduled Job again and go through the settings.

Testing Your Integration

After saving your scheduled job, you can run a test to ensure everything is set up correctly.

Click the Perform Test Run button. This will simulate a full integration sync, without importing any real data.

Additionally, within the Scheduled Jobs section, you will see a log of every successful and unsuccessful job, including the records created, updated, skipped, and when the job ran.

Did this answer your question?