Skip to content
English
  • There are no suggestions because the search field is empty.

Integrate SFTP with Engagedly

Table of contents

  1. Introduction
  2. Configure SFTP
  3. Set up user sync
  4. Before user sync
  5. Sync employee accounts
  6. Primary unique identifier

1. Introduction

Admins can securely integrate internal systems with Engagedly using Secure File Transfer Protocol (SFTP) to automate employee data syncs. This encrypted connection enables efficient transfer of employee information, such as new hires, profile updates, and deactivations, directly from your HRIS or internal database.

Integrating SFTP with Engagedly helps streamline administrative workflows, improve efficiency, and ensure the accurate and timely exchange of employee data. Learn more in the Overview of integrations.

2. Configure SFTP

Admins can either use the Engagedly-hosted SFTP configuration or create a custom SFTP configuration. For easier setup and support, we recommend using the Engagedly-hosted SFTP server. For more information, refer to Configure SFTP in Engagedly.

After configuring SFTP, paste the credentials into your FTP portal.

3. Set up user sync

Once SFTP is configured, set up the user sync process.

  1. Contact your IT admin to configure a data extraction process to fetch the user details from your HRIS or database in CSV or Excel format.

  2. Save the user details file in the SFTP folder using the provided credentials.

  3. Inform our support team after saving the file.

The support team then:

    • Verify the file for discrepancies.
    • Map the file columns to corresponding fields in Engagedly.

    4. Before user sync

    Before mapping and syncing, email our support team to configure the required settings.

    Enable or disable:
      • Block Non-Synced Users
      • Blocked User Creation
      • Sync Mapped Attributes only
    Choose:
      • Date format
      • HR manager and secondary manager fields using a delimiter, comma [,] or semicolon [;]
      • File extension (CSV or XLSX)
      • User identifier (Email ID or Employee ID)
      • Manager identifier (Email ID or Employee ID)
      • HR manager identifier (Email ID or Employee ID)

    After successful mapping, our support team notifies the engineering team to initiate syncing.

    When a file is added to the SFTP folder, syncing occurs automatically within 24 hours, and user fields are updated.

    You receive an email notification from our support team after successful integration.

    5. Sync employee accounts

    Contact our support team to schedule user data syncs to keep employee accounts up-to-date in Engagedly. Syncs can run once daily, twice daily, or at a frequency you specify.

    During each sync, Engagedly automatically:

    • Adds new employees
    • Updates existing employee records
    • Blocks or dismisses employees as required
    • Updates departments, job titles, and other mapping attributes

    Employee details update automatically after every sync. You may also request our support team to stop syncing at any time.

    6. Primary unique identifier

    By default, email ID serves as the primary unique identifier for employees. If you prefer to use employee ID, contact our support team to update this setting.

    ℹ️Additional information:

    • Do not change the sync file name after mapping. The system does not recognize renamed files.

    • Column mapping is based on column position, not column name. Keep the same column order in all future files.
      For example: If the employee's first name is mapped to the first column, it must remain in the first column in all future files.
    • Only CSV or XLSX formats are supported. Other formats (XML, PDF, Word) are not supported.
    • Ensure the following mandatory fields are included:
      • First Name
        • Last Name
        • Email ID
        • Employee ID
      • To terminate users through SFTP, use "Active" for active users and "Terminated" for blocked users in the "Status" column.
      • If your sync file includes only active users, any users not listed in the file are automatically terminated in Engagedly. Inform the support team before mapping and syncing.