ADP Canada Integration

How to integrate your Canadian ADP software so employees will automatically synchronize with your Bucketlist site.

This article describes the step by step process to integrate ADP with Bucketlist so you do not need to manually add your employees if you currently house them in that software. Changes made there will also reflect on your Bucketlist site. After the steps below are the fields read from ADP's API response, which shows what information in ADP will be transferred to Bucketlist.
  1. Log into your BL (Bucketlist) platform and copy the subscription key (provided by BL) under Integration > ADP > Integration Settings (if you do not see this option, please reach out to Bucketlist Support for us to work on that for you).
  2. Log into your ADP software with an administrator privilege

  3. Find the 'Bucketlist Connector' in the ADP Marketplace

  4. Select a package based on the amount of users (Small Business / Mid Market / Enterprise)

  5. After choosing the plan, you will need to enter the subscription key from step 1.

    When clicking on 'next', ADP will call Bucketlist, and Bucketlist will "connect" the BL platform to your ADP subscription. You can now go back to your Bucketlist platform under Integration > ADP > Integration Settings and a "subscription details" entry should now be visible.


ADP / Bucketlist final steps

  1. When the subscription is added, a 'synchronization' section should also appear in the ADP Settings/Integration page.


  2. You can now setup the company by pressing the 'Start' button.

  3. After clicking "Start", you will need to provide consent for BL to read ADP's data.

  4. Once done, we can enable the daily synchronization by clicking on the 'Enable' button.

When enabled, the synchronization will run daily over night. This will add and remove employees.

We also get data from the latest hires and terminations from ADP every 5 minutes. It means that if a user is added or removed from ADP, they should appear/be removed from the Bucketlist platform within 5 minutes. Please note that these requests cannot be guaranteed to work 100% (for example, if a network issue happens). That's why there is also a daily synchronization.

Fields read from ADP's API response:

Below are the fields that map over to Bucketlist from the ADP integration:

    • workerID: Unique field used to identify the employee

    • person/birthDate: Employee's birthday. The date format can be changed to mm-dd in ADP if we don't need the year.

    • person/legalName : Employee's first name and last name.

    • workerStatus: Mandatory

    • businessCommunication/emails : Employee's email

    • workAssignments/hireDate or workAssignments/seniorityDate: One or the other is used as employment date

    • workAssignments/workerTypeCode: Used for the field 'status' on Bucketlist's side

    • workAssignments/assignedOrganizationalUnits/Business Unit or workAssignments/assignedOrganizationalUnits/Department : Used for teams on Bucketlist's side.

    • workAssignments/reportsTo: Used to set the employee's managers on BL's side - this can be used on different features like emailing managers on nominations, etc.

    • workAssignments/jobTitle: Used to set the employee's permission on BL's side to 'manager' for specific job titles (if we don't use 'reportsTo')

    • workAssignments/workerTimeProfile: Used for setting the employee's timezone

    • workers/workAssignments/assignmentStatus: Used to determine if the employee should be added or removed to Bucketlist.

    • workAssignments/assignedWorkLocations or workers/workAssignments/homeWorkLocation: Used to set the employee's country