CMS Integration: Configuration

NOTE: An authorized user account is required to run this integration. To support better security and audit visibility, we recommend creating a dedicated "service account" user. When configuring this integration, sign in using the service account rather than your personal user account to ensure that audit logs reflect the service account running the integration instead of the user who originally installed it. 

Before You Begin

Before configuring the CMS integration, confirm the following are in place.

In CMS:

  • CMS Server URL: The base address of your CMS SOAP endpoint, provided by your CMS representative. Do not include a trailing slash.
  • Access Key ID and Key Code: Your CMS-Connect API username and passcode. These are not the same as your Compass portal login.
  • Company ID: The dealer identifier assigned to you during CMS setup.
  • Default Contact Auth ID: CMS requires every contact record to have an auth_id value (authorization level). Contact your CMS representative for the correct default value for API-created contacts before you begin. You will enter this value in Step 2 of the wizard. If this value is blank or incorrect, the integration may fail to create contacts in CMS.
NOTE: Only active CMS accounts are synced. Inactive or archived accounts are ignored.

In Rev.io:

  • No additional setup is required. Rev.io credentials are pre-configured by the integration.

Configuration

Complete the steps below to configure the CMS integration.

  1. Click Admin on the sidebar menu and select Integrations Library.
  2. Click the Marketplace tab.
  3. Locate and select the CMS Integration.
  4. Click the Configure button. A two-step configuration wizard will launch.
  5. Step 1: Connections. Enter the following CMS credentials. The Rev.io connection is handled automatically.
    • Server URL: The base address of your CMS SOAP endpoint.
    • Access Key ID: Your CMS-Connect API username.
    • Key Code: Your CMS-Connect API passcode.
    • Company ID: Your dealer identifier.
  6. Step 2: Settings. Leave Production Mode on unless your account team instructs you otherwise. Enter the Default Contact Auth ID required for API-created contacts in CMS. Click Finish.
  7. The integration will run an initial account matching pass. Active CMS accounts are matched to Rev.io customers using fuzzy name matching. Matches above the threshold are linked automatically and begin syncing immediately. Matches below the threshold are placed in a Pending review queue where you can accept, reject, or reassign each one from the integration settings page.
    NOTE: Pending links that are not acted on are not abandoned. On the next hourly cycle, the integration automatically creates a new Rev.io customer from the CMS account data and links them. Unmatched CMS accounts will always end up synced, either to an existing Rev.io customer you assign or to a newly created one.
  8. Once organization links are accepted, account name and address sync in both directions on an hourly cycle, and CMS contacts are imported automatically for each linked customer. See the Integrations Library: Data Sync & Mapping article for more information about managing your customer mappings.
  9. To sync new customers with CMS, open the Integrations tab on the customer profile screen and click the Sync button for the CMS integration.

Sync Timing

The table below describes when changes made in either system reach the other.

EventWhen It Reaches the Other Side
Integration first deployedInitial sync runs within minutes.
New CMS account discoveredNext hourly cycle. A new Rev.io customer is created automatically if no match is found.
Account fields updated in CMS or Rev.ioNext hourly cycle.
Contact added, updated, or removed in CMSNext hourly cycle.
Manual sync triggered from settingsImmediate.
NOTE: There is no real-time sync. CMS does not push notifications to Rev.io, so all changes wait for the next hourly poll. For time-sensitive updates such as an emergency contact phone number change, update both systems directly and let the sync confirm alignment on the next cycle.