Turning on ADP Partner Credentials in Merge

  1. In your Merge dashboard, go to Configuration > HRIS

  2. Find ADP Workforce Now in the list of platforms

  3. Check the box that says you'd like to authenticate users using your partner credentials

Now, let's find all the credentials we'll need from ADP!

Generating your signed ADP Certificate

In this step, we'll create a new SSL Certificate File and SSL Key File.

  1. Go to your ADP Partner self-service portal by visiting this link

  2. Click "Certificate" in the left navigation

  3. Click the "Request Certificate" button

  4. Fill in your details on the first screen and click Next

  5. Copy your Private Key from the second screen (the entire text portion, including ---BEGIN PRIVATE KEY--- and ---END PRIVATE KEY---)

  6. Open a text or code editor (i.e TextEdit, VS Code) and paste the Private Key

  7. Save the file and make the extension ".key"

  8. Continue through the Certificate process until you get back to the main screen

  9. Click "Download", which should download a ".pem" file to your computer

  10. In your Merge Dashboard, put in the ".pem" file as the SSL Certificate File and the ".key" file as the SSL Key File

Finding your Client ID, Client Secret, and Consent Link

  1. In your ADP Partner self-service portal (here), click "Projects" in the left-side navigation.

  2. Click on your development project

  3. Click "Development API Credentials" at the top of the page

  4. You'll see your Client ID and Client Secret in the first section. The second section has your Consent Link

  5. Copy and paste all of this information into the Merge Dashboard under OAuth Client ID, OAuth Client Secret and Consent Link

Finding your ADP Marketplace App URL, Client ID, and Client Secret

  1. In ADP Marketplace (here), go to the Developer dashboard by clicking your name in the top right corner, then clicking “Developer”

  2. Click “Edit” under your product that corresponds to your data connector app

  3. Click “Credentials” in the left navigation under “Integration”

  4. You will see your Marketplace Client ID & Client Secret under the “Inbound Credentials” section

  5. Copy and paste this information into the Merge Dashboard under Marketplace Client ID and Marketplace Client Secret

  6. Your app must be published to the ADP Marketplace to get your Marketplace App URL

    1. If your app is not published, you can input https://www.merge.dev as a placeholder for testing purposes

Configuring your ADP Marketplace App to Send Notifications to Merge

In this step, we will configure your ADP Marketplace App to send notifications to Merge whenever an end user subscribes to your app.

  1. In ADP Marketplace (here), go to the Developer dashboard by clicking your name in the top right corner, then clicking “Developer”

  2. Click “Edit” under your product that corresponds to your data connector app

  3. Click “Edit Integration” in the left navigation under “Integration”

  4. Enter the value for the “Subscription Create Notification URL” field. You can find this in the Merge dashboard under Configuration > HRIS > ADP Workforce Now.

    1. Be sure to append “?eventUrl={eventUrl}” to the end of the URL provided by Merge.

  5. Click “Add Required Info” underneath the “Subscription Create Notification URL” field

  6. Name the Form Title / Description whatever you would like. Add a text field within the form with the input code merge_token, and input title “Token”. You can set the input descriptor to whatever would be most helpful for your users.

  7. You must also populate the following fields in order for your application to be approved by ADP Marketplace. You can use the same URL as the “Subscription Create Notification URL” field if these events are not relevant to your use case. If they are relevant to you, you can populate these fields with webhook listeners from your application.

    1. Subscription Change Notification URL

    2. Subscription Cancel Notification URL

    3. Subscription Status Notification URL

    4. User Assignment Notification URL

    5. User Unassignment Notification URL

  8. Click Save at the bottom of the screen

  9. After saving, go to the “Credentials” tab

  10. Under Outbound Credentials, select Basic Authentication for Type, and input merge as your username and your organization’s name as your password

  11. Click Save to confirm your changes

Testing your connection with ADP

In this step, we will test the connection between Merge and your ADP Marketplace App. You can begin these steps once the steps above are complete.

  1. Log into ADP Marketplace using your ADP Workforce Now Connector App’s Test Instance User

  2. In your Merge dashboard, go to Linked Accounts > Test Linked Accounts and Add an ADP Workforce Now linked account.

    1. You should see a screen like the one below. If you don’t, make sure you’ve configured all of the necessary Partnership configuration parameters for ADP

  3. Copy the Merge Token you are presented with in Link. Don’t close this window.

  4. Once logged in, go to your data connector app in ADP Marketplace and click “Buy Now”. When prompted for the Merge Token in the ADP Marketplace flow, input the value you got from Merge Link in step 3.

  5. Finish the subscription flow, and continue with these steps once you’ve successfully subscribed.

  6. Go back to Merge. The “Next Step” button should now be clickable. Click the button to go to the next step.

  7. Now you must provide consent to the data connector app in ADP Marketplace. To do this, go to the "My Apps" section in ADP Marketplace, and click on the data connector app, where you will be prompted to provide consent. If it doesn't prompt you, it means that you have already consented.

  8. Go back to the Merge Linking Flow and click “I have provided consent” after providing consent in ADP Marketplace with your Test Instance User.

  9. This will kick off the initial sync, and if successful, a test linked account will be created. Reach out to Merge if you run into any issues.

Did this answer your question?