Step-by-step deployment guide

The Lucca connector imports Worker data from your Lucca environment into Elimity Insights. Each user becomes an Employee entity in Elimity Insights, enriched with their personal & organizational data.

Step-by-step deployment guide

1. Which data is imported from Lucca?

The integration with Lucca imports the following data per employee:

Attribute
Login
Email
First Name
Last Name
Job Title
Employee Number
Department
Department Code
Legal Entity
Manager Id
Manager Name
Manager Email
Seniority Date
Contract Start Date
End Date
Last Modified
Status
Primary Role
Secondary Roles
Contract Type

The connector calls Lucca's user API (GET /api/v3/users) and pages through every user, requesting these fields via Lucca's fields= projection and department, manager and legal entity come back embedded on the same response.

Contract Type is fetched from a second call to the work-contracts API (GET /directory/api/4.0/work-contracts) and matched to each user by their ID.

Status is derived from the contract end date (a user is inactive if their contract ended in the past otherwise active). Former employees are also imported. To see only active or only former users, please filter on the status attribute in Elimity Insights. Sensitive data (bank details, social security number, health, home address, birth date) is intentionally not imported.

2. Request API access from Lucca

The connector authenticates against Lucca with an API key, sent on every request as the header Authorization: lucca application=<api_key>.

An administrator generates the key in Lucca. Please see Lucca's Generating an API key guide. Each key is given its own dedicated role that determines its access, the key needs read access to users, departments, legal entities and work-contracts.

In the end you should have the following configuration values:

• The Lucca instance URL (host) e.g. https://your-instance.ilucca.net

• An API key (api_key)

Tip: before continuing please confirm the key works with a quick call: curl -H "Authorization: lucca application=<api_key>" "https://<host>/api/v3/users?paging=0,1" If it returns a user, the connector will authenticate too

Note: Lucca rate-limits API requests to 50 per minute per domain. The connector stays well under this and retries on 429 responses.

3. Configure the source in Elimity Insights

You can now register the connector in Elimity Insights:

1. Go to Sources in the left navigation bar and click Add Source.

2. Search for Custom and click Set Up.

3. Click Set Up again and give the source a name (e.g. Lucca).

4. Select Upload export file, click Continue and upload the data model file: insights-client-lucca-data-model-export.json

insights-client-lucca-data-model-export.json

5KB

Open

1. Open the Config tab and click Edit.

2. Check the Enable automatic imports via custom gateway and fill in the Gateway URL: https://lucca-gateway-1027270379075.europe-west1.run.app

3. Click Add configuration value and add the two entries below.

Key	Type
host	Text
api_key	Password

host and api_key are required. If either of host or api_key is missing or incorrect, the connector will fail to authenticate against Lucca and the import will not start.

1. Click Save and run to launch your first import. You can monitor the progress in the Logs tab, and the Imports tab will show the summary for each run.