Overview

Merge is pleased to announce that we're a HiBob-supported Global API provider. Our partnership means you're able to offer an OAuth-based integration to your customers.

To allow your customers to link HiBob accounts, you will need to register as a HiBob tech partner, set up a HiBob OAuth App, and enter your application credentials within Merge by following the steps below.

HiBob requires every partner to use their own OAuth app. You must create an OAuth app and have it approved by HiBob to go live on the Bob Marketplace.

Instructions

Step 1: Register as a HiBob tech partner

1. Before you'll be able to connect to your customers' HiBob instances, you'll need to register as a HiBob partner by filling out their tech partner application form at the link below.

   1. https://dash.partnerstack.com/application?company=hibob&group=techpartnerapplication&gref=page

   2. The last question in the form asks if you are using a Unified API provider. Select Merge from the dropdown.

   The form mentions a marketplace fee, but it does not apply. HiBob has confirmed the fee is fully waived for partners onboarding or migrating to the Bob Marketplace, including Merge customers, and does not plan to bring it back as a flat annual fee. If HiBob's Marketplace pricing changes in the future, HiBob will communicate it well in advance.

2. Once approved, you’ll have access to the HiBob Partner Portal (via PartnerStack), where accepting the T&Cs will unlock access to a dedicated Bob test account and the HiBob Developer Portal

Step 2: Create your app in the HiBob Developer Portal

1. Using the credentials you were provided in Step 1, log in to the HiBob Developer portal

   1. https://developers.hibob.com/dashboard/apps

2. Create a new app by selecting the Create app button, and providing a name and description for your app

   

3. A new row will be added to the table. Click on the row.

4. Under Basic information, provide a logo, name, and description for your app

5. Scroll down to the bottom of the Basic Information page and configure the Installing your app section:

   1. Choose the Install from your landing page option

   2. Populate the Landing page URL

      1. Note: The landing page URL is where your customer will be redirected when they select the "Install" button on your app in the HiBob marketplace. Most customers opt to direct the user to the login/signup page of their app or their integrations page.

   

6. Under OAuth, scroll down to Redirect URI and add a Redirect URI of https://app.merge.dev/oauth/callback then click Save

   

   If your Merge organization is on our EU region, also add https://app-eu.merge.dev/oauth/callback as a Redirect URI in your HiBob app, and contact [email protected] before linking any accounts. This is a temporary step while we fix a known issue.

7. Under Scopes, select Manage scopes and add the scopes required for your use case.

   1. Note, you may add additional permissions required for your use case as well

   2. If your app requests fewer than these five scopes, contact [email protected] before your customers link so we can adjust the scopes Merge requests for your organization.

   Scope	Required for
   Settings > View company metadata	*All use cases
   People > View employee data	*All use cases
   People > View employee historical data	Employment data
   People > View employee sensitive historical data	Pay rate data
   People > View sensitive employee data	Sensitive employee data such as Date of Birth and SSN
   Time Off > View time	Time off data

   

8. Under App listing details, populate your listing information.

   1. App gallery: these 3 images will appear on your marketplace listing

   2. Value statement: the value statement of your product

   3. Functionality and how the integration works: brief overview of what your integration does

   You can refer to the HiBob marketplace for inspiration!

9. Still under App listing details populate your integration details, then click Save.

   1. Integration type: API

   2. Direction of data flow: From Bob - unless you use passthrough to write data back to HiBob

   3. Sync Trigger: Scheduled and manual

   4. Sync Frequency: Scheduled and manual

   5. Region: The region of your app

   6. Marketplace category: The marketplace category of your app

Step 3: Add your development credentials in Merge

1. Navigate to the OAuth section of your app and copy your App ID and Development Client ID and Client Secret

   

2. Log in to the Merge Dashboard and navigate to the HRIS Integrations tab

3. Scroll down to the HiBob integration, open the drawer, and select Set up organization-level credentials

   

4. Enter the following information in the corresponding fields, then save.

   • App ID: App ID

   • OAuth Client ID: Development Client ID

   • OAuth Client Secret: Development Client Secret

   • OAuth Redirect URI: https://app.merge.dev/oauth/callback

If you run into this error during the linking flow:

{
"success": false,
"errorMessage": "App is already installed in DEV mode: installationId= <installation_id>"
}

In the HiBob Developer Portal, open your app > OAuth, and click Uninstall

Step 4: Test the integration

After inputting your Development credentials in the Merge Dashboard, we highly suggest testing the integration

• Note, make sure to choose the Use my credentials and Sandbox data options when going through the linking flow

Step 5: Build a customer-facing user guide for your integration

HiBob requires each marketplace partner to provide a user guide to the end user. The user guide should explain your integration and walk your customer through the installation process. The requirements include:

• Overview of the integration

• Installation steps

• Setup in your platform

• Data sync flows

• Screenshots or short clips

• Troubleshooting tips

• Support contact info

Step 6: Record a demo video of your integration

HiBob requires a video of your integration before your app can go live.

Your video and user guide must show the OAuth flow only. Do not show the Service User option in Merge Link, since HiBob will reject submissions that use it. Your video must also be recorded within 14 days of submitting your app and show a visible use for every scope your app requests.

The video should detail your integration end-to-end. The full requirements of the video can be found at the link below.

• https://apidocs.hibob.com/docs/add-and-submit-an-app#video-flows-coverage

Step 7: Submit your app for review

1. Once you have your user guide and video, you're ready to submit your app for review!

2. Log back into the HiBob developer portal and navigate to the Submission information page of your app

3. Input the URL for your Integration demo and User guide and click Save

   

4. The Submit for review button should now be available

   

5. Give your app one final look over and click the Submit for review button to submit your app for review

Step 8: After approval, input your production credentials in Merge

1. Once your app is approved by HiBob, navigate to the OAuth section of your app and copy your App ID and Production Client ID and Client Secret

2. Log in to the Merge Dashboard and navigate to the HRIS Integrations tab

   

3. Scroll down to the HiBob integration, open the drawer, and select Edit to modify your credentials

   

4. Enter the following information in the corresponding fields, then save.

   • App ID: leave as is

   • OAuth Client ID: Production Client ID

   • OAuth Client Secret: Production Client Secret

   • OAuth Redirect URI: https://app.merge.dev/oauth/callback

   If you are in EU tenant, the redirect URI should be https://app-eu.merge.dev/oauth/callback

That's it! If you have any questions reach out to your CSM or [email protected]