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.

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.
• Your organization’s Lucca Base URL, in the format shown in Deel, such as https://example.ilucca.net.
• A valid Lucca API key. Treat this key as sensitive information and do not share it in screenshots, tickets, or chat messages.

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.
     • Consult HR files - Scope: All items all departments. 
     • Consult contractual information of employees - 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. In the left sidebar, expand Apps & Automation, then select App Store.

   

2. In the Find apps field on the Apps overview page, enter Lucca API.

   

3. Select Lucca API, identified by the description HR and administrative software.

   

4. Select Connect Lucca API.

   

5. Enter your organization’s Lucca Base URL and the API Key generated in Step 1. The connection form auto-saves your entries.
6. When Connect & go to settings becomes available, select it.

   

Deel validates the credentials and opens the Lucca API integration settings page.

Step 3: Configure the integration

Configure how data flows between the two systems:

Note: Use Apps & Automation > App Store to manage the Lucca API integration. Agentic workflows and legacy workflows do not contain the Lucca API plugin controls.

1. From the connected Lucca API integration settings, open the Plugins section. Locate Global Payroll - People Data Sync and click Enable. Wait for the enablement process to finish before navigating away.
2. Select the Lucca paygroup and corresponding Deel paygroup.
3. Select the default permission group.
4. Set the sync frequency, time, and time zone.
5. Map Lucca fields to Deel fields. For unavailable items, such as Contract Custom Fields, select item not available and provide a Fallback value. Ensure the fallback value is correct, as an incorrect value can have a payroll impact.
6. Click Continue to enable the plugin.

Once the plugin is enabled, the initial sync will process. You can verify Global Payroll - People Data Sync shows as ENABLED in the Lucca API Plugins section. If the status does not update immediately, wait briefly, refresh the integration settings, and check again.

Troubleshooting