How to connect Lucca API to Deel

Deel connects with the Lucca HR API to automate your data workflow, specifically for Global Payroll (GP) People Sync. This allows you to automatically onboard, amend, and terminate direct employees by syncing data from Lucca to Deel.

If you are looking to sync data via the STFP, refer to our Lucca Connection Guide.

In This Article

• Before you begin
• Step 1: Prepare Lucca HR
• Step 2: Connect the integration
• Step 3: Configure the integration

Before you begin

Ensure you have:

• Lucca Admin Access to generate API keys and configure permissions.
• Deel Admin Access to manage apps and integrations.

Step 1: Prepare Lucca HR

Before connecting to Deel, you must configure your Lucca HR environment:

1. Log in to Lucca and go to Settings, then API Keys under the Security section.
2. Click Generate a new API key.
3. Fill in following details:
   • Key name: Descriptive name (e.g., "Deel Integration").
   • Permissions: Check Consult leaves under Absences, View expense reports under Expenses, and  View timesheets under Timesheet.
   • Technical contact: Provide an email.
   • API key usage: Select Third-party publisher and enter Deel.
4. Click Generate a new API key.

After generating the key, configure permissions via Role settings linked under the key entry:

1. Go to the Permissions tab.
2. Configure access for:
   • Coworkers under Employee Administration:
     • Add access for: Consult the who's who (Scope: All departments , See future employees, See former employees.
     • Read users' Lucca properties - Scope: All departments.
     • View employee jobs - Scope: All departments.
   • Compensation under Compensation and Benefits:
     • Add access for: Access the compensation and headcount dashboard (Scope: All departments) and Access individual situations (Scope: All departments).
3. Save changes each time you add permissions to a category.

Step 2: Connect the integration

1. Log in to Deel, navigate to Apps, and search for Lucca API.
2. Click Connect Lucca API.
3. Enter your Base URL and the API Key generated in Step 1.
4. Click Connect & go to settings.

Step 3: Configure the integration

Configure how data flows between the two systems:

1. Locate Global Payroll - People Data Sync under Plugins and click Enable.
2. Select the Lucca paygroup and corresponding Deel paygroup.
3. Select the default permission group.
4. Set a frequency for the sync, and specify the Time, and Time Zone.
5. Map Lucca fields to Deel fields. Make sure to handle missing items (e.g., Contract Custom Fields) by selecting "item not available" and providing a Fallback value.
6. Click Continue to enable the plugin.

Once the plugin is enabled, the initial sync will process. You can verify the status shows as ENABLED on the Lucca API plugins page.