How to set up a Lucca integration

In this article, we’ll run through how you can seamlessly integrate your Lucca system to provision and de-provision users on Reward Gateway.

How to enable the Lucca integration?

To enable the Lucca integration, log into the Reward Manager portal, go to Integrations on the left and search for Lucca under Explore Integrations. 

Click on the integration icon which will lead you straight to the Initial Setup.

Step 1: Initial Setup

Select the import frequency, date format and whether you wish to send Welcome communication to newly added members. We recommend ticking the Welcome e-mail option, as this provides easy first-time access to the platform to new users and allows them to set up a password. 

Step 2: Authorize the Lucca Account

Before Reward Gateway can access your Lucca data, you must authorize Reward Gateway to access your Lucca account. To do this, click the Authorize button.

This will open a modal window where you will need to enter your Lucca subdomain.

• Sign in to Lucca
• Go to the home page
• Find the domain for your Lucca account in the URL. For example, if the URL is "https://merge.ilucca-demo.net/home", then the domain is "merge.ilucca-demo.net"
• Enter the domain in the field below

In the next step, you will be asked to enter your Lucca API key

How to generate your API key?

To create a new API key, go to the Cogged wheel > Authentication, SSO and API > API Keys. If you don’t have access rights, please contact Lucca's support team.

Click on Generate API key to create a key.

In the creation window, you can

• Customize the name of the key
• Select the permissions you wish to associate with this key

Advanced settings: you can personalize your key. However, you must abide by the GUID (globally unique identifier) format, which requires a unique identifier with a size of 16 bytes (example: {3F2504E0-4F89-11D3-9A0C-0305E82C3301}).

Once the key has been generated, you can copy the key by hovering the mouse over it.

Copy and add the API key in Reward Manager.

After you authorize your account see the confirmation message, click ‘Finish Setup’ and then ‘Save’.

You can revoke the access at any given time.

Step 3: Mapping

Before Reward Gateway can sync your Lucca directory, you need to map the fields which are going to be synced. To do this, use the mapping stage of the setup and use the fields displayed. Once ready, click ‘Save’.

By default, Reward Gateway maps the Employee ID to uniquely identify a member. Any other additional mapping fields can be mapped during this stage, however, the Email Address field must be mapped as it is a mandatory field to create an account with Reward Gateway.

Once you are happy with the mapping, you can proceed to the next step.

Step 4: Review and Publish

At this stage, you can review the details and if you’re happy, publish the connection. This will make the integration live on the platform and Reward Gateway will start syncing the data based on the frequency selected at the Initial step.

How will you monitor when your Lucca data syncs?

Every time your Lucca data is synced, Reward Gateway sends an email to the user who set up the integration with details on how many accounts it has impacted.

You also have the option of going to the integration Dashboard and selecting the "Import History" option to see a log of all data syncs that have been performed on your platform.

If there were any issues with your data sync, you’ll be able to download a file containing all of the errors.

How will your employees get onboarded once your Lucca data has been synced?

If it's a new employee record that is synced from Lucca, Reward Gateway will create a new account for this employee based on the information mapped and will send them an invitation to join the program. 

If it's an existing employee whose data has already been synced, Reward Gateway will not issue any communication and will update their information to match their Lucca information.

How will the employee data be removed once an employee is removed from your Lucca directory?

Reward Gateway uses the employment status to determine whether a user needs to have their account created, or be marked as a leaver in our system. This means that we will mark everyone whose employment status is inactive as a leaver.

The employee's account will then follow Reward Gateway's standard account close-down procedures.

How can you trigger your membership provisioning imports on demand?

You have the option to trigger the import on-demand from 'Import data now' link in the tools dropdown. This will redirect you to the import page where you can start the process. Once started, a progress bar will be presented and when the upload is completed, you will be able to download any warnings and see the impact on your programme.