Import Omnichannel Contacts

Prev Next

Rocket.Chat’s Import feature allows you to import Omnichannel contacts using .csv files via three options:

  • Upload a .csv file from your local machine. To use this option, make sure that your workspace’s File Upload Settings are configured.

  • Enter the public URL where the file is available.

  • Provide the server file path where the file resides in your Rocket.Chat server deployment.

To use this feature, your workspace must be on the Enterprise plan and have the Trusted Contact Management feature enabled.

CSV file structure

The .csv file must contain three primary fields:

  • name

  • emails

  • phones

The system tries to find a custom field in Rocket.Chat for each additional column in the .csv file other than the primary ones listed above. So if you have additional fields, set them up as Custom Fields in Rocket.Chat to import them successfully. For example, if you have social-number as an additional field, create the corresponding custom field Rocket.Chat first. Make sure that the Scope of the custom field is Visitor. The Field value must be the same as the column name of the additional field, in this case, social-number.

The following screenshot shows an example of the custom field:

The following snippet shows a sample .csv file:

name,emails,phones,social-number
Jamie Larsen,[email protected],7127434955,591-80-9596
Misty Hendricks,[email protected],890-205-3908,727-76-6572
Jennifer Rodriguez DDS,[email protected],916.501.0002,454-08-9024
Melissa Gonzalez,[email protected],(343)461-6364,671-11-4733
Kathleen Huff,[email protected],671.625.7847x29029,767-20-5160
Adam Jones,[email protected],001-528-446-3743,287-81-9282

Now your file is ready to be imported.

Import CSV file

  1. In your Rocket.Chat workspace, go to Administration > Workspace > Import.

  2. On the Import page, click Import New File.

  3. From the Import Type drop-down menu, select the Omnichannel Contacts (*.csv) option.

  4. Select the File Type from the drop-down menu.

    1. If you select Upload, you can upload the file from your machine. Check your workspace’s File Upload Settings to ensure you can upload the file successfully.

    2. If you use the Public URL option, enter the File URL where the file is available.

    3. If you use the Server File Path option, enter the File Path where the file resides in your Rocket.Chat server deployment.

  5. Click Import.

  6. Once the file is parsed and loaded, you will find the list of contacts from the Contacts tab as shown in the following screenshot:

  1. You can verify the contacts here and remove any you don’t want to import by deselecting the checkbox.

  2. Click Start Importing.

Your Omnichannel contacts are now available in your workspace! If you encounter problems during the import process, you can view the logs by clicking Reports in the admin section.