Connect

This guide provides the steps to connect a Darwinbox account to Zluri

Prerequisites

  • Super Admin access to the Darwinbox account.
  • The Darwinbox Studio module is enabled on the account. If Studio is not available, contact the Darwinbox account manager to create the API user and API keys listed in Steps 1 and 2.
  • The Darwinbox instance URL (for example, https://{company}.darwinbox.in).

Step 1: Create an API User in Darwinbox Studio

  1. Log in to the Darwinbox account with the Super Admin role.

  2. Navigate to Modules > Darwinbox Studio.

  3. Under Studio Users, select Add Studio User.

  4. Enter the following details:

    1. Username: a recognizable name such as Zluri Integration
    2. Type: External
    3. Email: an admin email address owned by your organization
    4. User ID: a unique identifier
    5. Password: a strong password
  5. Save the user.

  6. Copy and securely store the Username and Password. These are used for Basic Authentication.

Step 2: Generate the API Keys and Dataset Keys

  1. In Darwinbox Studio, navigate to Darwinbox API Keys.

  2. Select Configure Darwinbox API.

  3. Create an API key for Active Employees:

    1. Authentication Type: Static Key

    2. Configuration Name: Zluri Integration Active Employees

    3. User: the Studio user created in Step 1

    4. Module: Core

    5. Endpoint: /masterapi/employee

    6. Dataset Key: select the active employees dataset under Core

    7. Save, then copy the API Key and Dataset Key from the popup


    6.Select the employee fields to include in the dataset (see the note below), then select Create.

  4. Repeat the previous step to create an API key for Inactive Employees on the same /masterapi/employee endpoint, with the dataset filtered to inactive employees.

    Create an API key for Inactive Employees:

    1. Key Type: Static Key
    2. Configuration Name: Zluri Integration Inactive Employees
    3. User: the Studio user created in Step 1
    4. Module: Core
    5. Endpoint: /masterapi/employee
    6. Dataset Key: select the inactive employees dataset under Core
    7. Save, then copy the API Key and Dataset Key from the popup
  1. Copy and securely store each generated API Key and its Dataset Key for both Active and Inactive users.

Note: Include at least the following fields in both datasets: employee ID, full name, company email, personal email, reporting manager email, employee status, department, designation, cost center, business unit, office location, date of joining, and date of exit.

Step 3: Begin the Integration in Zluri

  1. Log in to the Zluri dashboard >catalog.

  2. Open the Darwinbox Integration page.

  3. Select Connect Integration or Connect another instance if an existing connection is already configured.

Step 4: Review and Add Scopes

  1. Review the required scopes displayed for the integration.
  2. Add additional scopes as needed for custom use cases or advanced access, such as Update Employee Email ID for onboarding workflows.

Authorization Options

Self-Authorization

  • Proceed directly to Step 5 to complete authorization.

Co-worker Authorization

  1. Enter a co-worker's details to share the access request.
  2. Zluri sends an invite email or link containing a unique Connect Code.
  3. The co-worker can use the code to approve and complete the connection setup.

Step 5: Authorize the Connection

  1. Depending on the authorization method (self or co-worker), enter the necessary credentials.
  2. Enter the Darwinbox instance URL in the Instance URL field.
  3. Enter the Username and Password from Step 1.
  4. Paste the API Key and Dataset Key for active employees into the Active Employees API Key and Active Employees Dataset Key fields.
  5. Paste the API Key and Dataset Key for inactive employees into the Inactive Employees API Key and Inactive Employees Dataset Key fields.
  6. (Optional) Paste the update API key into the Update Employee Email API Key field.
  7. Select Connect to complete the integration.

Integration Complete

Zluri is now successfully connected to Darwinbox and will begin syncing data automatically.

Got questions? Feel free to submit a ticket or contact us directly at [email protected].


Did this page help you?