For the complete documentation index, see llms.txt. This page is also available as Markdown.

Lucca

Connect Lucca to Cakewalk as an identity source: the role you need, and where to create the API key and enable its permissions.

Lucca connects to Cakewalk with an API key you create in Lucca's security settings; for the shared flow, see Connecting an HRIS.

✅ Before You Start

  • Your Lucca user roles must include Other → Lucca → Roles and API Key management.

  • To check: click your user icon in the top bar, click Settings under Administration, then under Settings → Security click API Keys. Verify you can see the Generate API Key button. If you cannot, ask a system administrator to assign the "Roles and API Key management" role to your account.

🛠 Connect

  1. In Cakewalk, go to Settings → Data Sources → Users and select Lucca.

  2. Note your Lucca domain: it appears in the URL bar in the form https://example.ilucca.net.

  3. In Lucca, click your user icon in the top bar, click Settings under Administration, then under Settings → Security click API Keys and click Generate a new API Key.

  4. Enter a name for the key under "Key name" and select at least one permission to create it: start with Collaborators → View / create / edit users, you can fine tune permissions later. Enter the email address of someone in IT or HR under "Technical contact", select Internal use for "API key usage" and click Generate a new API key.

  5. Copy the new key with the copy button to its right, enter your Lucca domain and paste the key into the connection flow, then click Continue.

  6. Back on Lucca's API Keys page, locate the key you created by its name and open its role administration. In the Roles page, find the key by name in the sidebar on the left and click it.

  7. Enable each permission the connection flow requests: under the Permissions tab, open the parent permission with the plus icon, then check the requested sub permissions. Repeat for every requested permission, then click Save in the bottom right corner. The connection flow shows the exact list.

  8. Click Set up integration in the connection flow.

The first sync starts immediately. Sync details and cadence: Connecting an HRIS.

Last updated

Was this helpful?