Salesforce integration on Vome: two-way contact sync

How does the Salesforce integration work on Vome?

Overview

The Salesforce integration keeps Salesforce contacts and Vome profiles in step with each other. It is a two-way sync: contacts created or updated in Salesforce flow into Vome, and events in Vome flow back to Salesforce through a webhook.

You install a managed package into your Salesforce org, point it at Vome with an API key, and map the fields you care about.

The Salesforce integration requires the Ultimate plan, because it authenticates with a Vome API key.

Info
This is the most involved integration Vome offers. It is a Salesforce administrator's job, not a coordinator's. Budget proper time for it and do it in a sandbox first.

Why use it

  • One record per person across both systems. Your development team and your volunteer team stop working from different lists.

  • Volunteer activity becomes visible to fundraising. Someone giving time and someone giving money show up on the same contact record.

  • No manual exports. The sync runs on contact creation, on contact update, and on a daily schedule.

  • You control the mapping. Field mapping is configured in Salesforce, so you decide which fields travel and which stay put.

What syncs, and in which direction

  • Salesforce to Vome. Contact and account data, driven by three triggers: when a contact is created, when a contact is updated, and on a daily scheduled run.

  • Vome to Salesforce. Event-based updates delivered to a webhook endpoint you expose from a Salesforce Site, for example when a new profile is added in Vome.

Before you start

You will need:

  • System Administrator access in Salesforce

  • A Vome API key, plus the Client ID and Client Secret for the connection

  • A Vome subscription on the Ultimate plan

  • A sandbox to test in, strongly recommended before you touch production

Generating your Vome API key

  1. From the left-hand navigation in Vome, click Integrations & Apps.

  2. Click APIs & webhooks.

  3. Open the API keys tab, click Generate secret key, give it a title such as "Salesforce", and copy it immediately. The key is shown once.

How to set up the integration

The full step-by-step, including the managed package install link, is on the Vome developer documentation site. In outline, the setup runs like this:

  1. Install the managed package into your Salesforce org. Use the sandbox install link first if you are testing.

  2. Enable "Deploy Metadata from Non-Certified Package Versions via Apex" in Apex Settings.

  3. Create a Salesforce Site and grant public access to the VomeWebhookEndpoint Apex class. This is what lets Vome push events back to Salesforce.

  4. Configure Vome Settings, OAuth Configuration and Field Mapping through Custom Metadata Types.

  5. Activate the "Sync Contact To Vome Trigger" flow.

  6. Review the Integration Dashboard, across its Settings, Field Mapping and Integration Rules tabs.

  7. Confirm all three integration rules exist and are active.

  8. Assign the "Vome Integration User" permission set to the users who need it.

  9. Register your Salesforce Site URL as a webhook endpoint in Vome, under Integrations & Apps then APIs & webhooks.

Common reasons records do not sync

  • The field mapping bundle is inactive. Records will not carry across until the mapping is active.

  • The sync flow was never activated. Installing the package does not switch the flow on for you.

  • The webhook endpoint is not registered in Vome. Without it, nothing flows from Vome back to Salesforce. Check the Logs tab in Vome's developer console to see what was attempted.

  • The permission set was not assigned. Users without it will not see the integration behave as expected.

Developer documentation

The complete installation guide, with the package links and the exact metadata values, is here: https://docs.vomevolunteer.com/integrations-and-automations/salesforce

For the underlying key and event model, see How do the Vome API and webhooks work?

Need help?

If the sync is not behaving, contact our support team at https://support.vomevolunteer.com/. Tell us which direction is failing, Salesforce to Vome or Vome to Salesforce, and it will get to the right answer much faster.

Summary

  • Two-way contact sync between Salesforce and Vome, on the Ultimate plan.

  • Salesforce to Vome runs on contact create, contact update and a daily schedule.

  • Vome to Salesforce runs through a webhook endpoint exposed from a Salesforce Site.

  • Setup is a Salesforce System Administrator task, done through a managed package.

  • If records are not syncing, check the field mapping bundle, the sync flow and the webhook registration first.