Information for: DEVELOPERS   PARTNERS

Vtiger plugin setup

This article describes how to set up the integration between Vtiger and Campaign Studio.

Get Vtiger client credentials

  1. Sign in your Vtiger account and navigate to User Preferences.
  2. Copy:
    • The root of your Vtiger URL from the address bar
    • Your Vtiger User Name, located in the User Login & Role section in your My Preferences page)
    • The Access Key, located at the bottom of the My Preferences page under User Advanced Options)

Vtiger client credentials page

Add Vtiger credentials to Campaign Studio

After you have the Vtiger credentials:

  1. Sign in to your Campaign StudioAccount.

  2. Click the Settings gear in the upper right corner, and then click Plugins at the bottom of the list.

    Adding Vtiger credentials to Campaign Studio

  3. Click the Vtiger logo to open the configuration dialog box.

  4. Add the Vtiger URL, Vtiger username, and Vtiger access key.


  5. Click Save & close.

Features configuration

  1. Click the Features tab to configure Campaign Studio and Vtiger to interact.


  2. For Campaign Studio and Vtiger to sync, select the check box next to Sync objects between Mautic and this integration.

  3. Select the objects to sync with Campaign Studio: Lead, Contact, and Company.

  4. Select the check box next to Update the Contact Owner based on Vtiger Owner if desired.

  5. If you’ll be updating the Do Not Contact status of your Contacts/Leads in both platforms, select the check box next to Use latest updated Do Not Contact record, to ensure this status stays up to date.

  6. Select an option from the Choose owner for Contacts menu to set a default owner for contacts.

  7. Select an option from the Push Mautic Contact to Vtiger menu; either a Contact or a Lead.

Contact, lead, and company field mapping

After configuring the credentials and features, ensure the Vtiger Plugin is enabled and authorized. Mapping any Contact, Lead, or Company fields requires authorization. Fields default to sync both ways.


To change the mapping:

  1. Select a tab for the mapping type to update:
    • Lead Field Mapping
    • Contact Field Mapping
    • Company Field Mapping
  2. For each Vtiger field, select a Campaign Studio field to map to.
  3. For each field, select a sync direction:
    • Sync both ways
    • Sync only to the integration
    • Sync only to Mautic
  4. When finished, Click Save & Close.

Use the Filter integration fields… text box to filter through the fields and find the ones you’d like to map. The fields before the menu are the Vtiger fields, and the fields inside the menu are the Campaign Studio fields you’ll be mapping to.


Repeat the process for the fields you’d like to map. Contacts should begin syncing between the two platforms. If you have questions, contact Acquia support.