How to integrate with Lucca

Prerequisites

The primary prerequisite to be able to set this integration up is your account must have "Admin" rights. Here's how you can check if you have these rights:

• Log in to your Lucca account and navigate to the upper right corner of the screen and click on the "gear" icon and navigate to “API Keys”:

If this section is not appearing you do not an Admin user in Lucca. If this is the case, please reach out to the person in your organisation that does have these rights to continue setting up this integration.

Step by Step Instructions

Ravio App on Lucca Marketplace

Ravio now has an official app on the Lucca Marketplace! If you wish to use this please follow the steps listed here:

• https://support.lucca.fr/hc/en-us/articles/8547420248220-Ravio-via-Kombo-A-real-time-pay-solution

Once the API Key is generated, skip to Step 4 of the instructions below.

Custom API Key

Step 1 - Creating a new API Key in Lucca

Navigate to the API Keys page as per the above and click ‘Generate a new API key’.

To generate an API key, follow these steps:

1. Enter a name of your choice for your API key under "Key name".
2. To create a key, you must select at least one permission. We recommend you to select "Co-workers → Consult / create / modify users" and “Timmi Absences → Consult Leaves”. This is just temporary as we will be fine tuning the permissions at the next step.
3. Enter an email address of someone in the IT or HR department that's responsible for this integration under “Technical Contact”.
4. Select "Internal Use" under "API Key Usage"
5. Click on “Generate new API key”.

You should now see your API Key newly created on the API Keys page:

Step 2 - Enter this information in Ravio

Now switch into the Ravio app to start the onboarding workflow. Once selecting the Lucca HR system you will be prompted to add your Lucca domain which can be found in your URL bar.

Once you have entered this information, paste the newly created API Key into the required section and hit continue.

This will being up the next page which tells you which permissions the Ravio app will require.

Step 3 - Fine tuning the API Key permissions

Continuing through the process as above will bring you to the next page in Ravio which details the permissions that the API Key will require to make sure Ravio has all the information required to properly benchmark your company.

The first step is to navigate back to your API Key in Lucca, and select ‘Role Administration’.

This brings up the role permissions screen where you should navigate to the API Key we just created by searching for the name in the search box in the top left of the screen and making sure this is selected.

Then we need to make sure the permissions that Ravio requires are all added. As an example, if we want to add the permission “Pagga Compensation → Access Individual Situations”, we would find Pagga Compensation in the permissions list and hit the + button to open up the individual accesses.

Once this is done we would just tick the box for the required permission, and click Save.

This would then be repeated for all of the permissions that Ravio requires. You can find a full list of the required and recommended permissions below.

Step 4 - Updating this information in Ravio

Once this last step is completed, you can go back to Ravio and select ‘Set up integration’. If everything is done correctly you should see a Success message, if not please go to ‘Troubleshooting’ below.