Salesforce Setup

Sync all your Salesforce data to your database in real-time. Rapidly build your Salesforce integration using SQL, ORMs, and the Sequin Proxy.

This guide walks you through setting up a real-time sync between Salesforce and your database using Sequin.

In just a couple of minutes, you'll initialize your sync, query your Salesforce data, and complete your integration by updating a Salesforce contact using the Sequin Proxy.

note

You'll need to ensure that you have access to a Salesforce user with permissions to access the Salesforce API.

Create a Salesforce sync

Connect Salesforce and your database to Sequin to start your sync.

Step 1: If you don't have one already, create a new Sequin account at https://app.sequin.io/signup.

Step 2: Select Salesforce as the platform you want to sync.

Step 3: Now connect your Salesforce instance to Sequin by selecting Add new API key. Enter your Salesforce subdomain. You can find your Salesforce subdomain by logging into the Salesforce instance you want to sync and copying the root of the URL:

Click Connect to Salesforce and finish connecting to your Salesforce instance by entering your Salesforce credentials in the authentication modal:

Step 4: Set the rate limit for your sync. By default, Sequin will use 29,000 requests per day. We have some tips to help you determine how many API calls to allocate to your sync.

Step 5: Select the Salesforce objects you want to sync to your database. Sequin syncs standard objects and custom objects to tables in your database.

Step 5: By default, Sequin syncs all the standard and custom fields of each Salesforce object to columns in your database. You can choose which fields will sync to your database and edit the column name for each field by clicking the gear icon.

Step 6: Connect to the destination database you want to sync your Salesforce data to. We suggest you sync to a database you host by choosing the Connect option and following the steps to connect to your database. Or, if you want to get up and running quickly, click the Launch option to spin up a demo database we host for you (on Amazon RDS.):

Step 7: Click Create.

After you click Create, Sequin will begin backfilling all your data. We'll show you the progress we're making in the console. Within a minute or two, you can begin exploring your schema and querying your data in SQL. We'll send you an email when your backfill is complete.

Query your Salesforce data using SQL

Connect to your database and start querying Salesforce using SQL. We'll use psql as an example in this setup guide, but you can use any SQL client that works with Postgres.

Step 1: Copy the psql command to connect to your database by clicking View database credentials.

Step 2: Open your terminal, and paste the psql command. Press Enter. This will open a connection to your database so you can write your first query:

psql -d {your_connection_string_here}
psql (14.2, server 12.11)
Type "help" for help.

dbh2vw0hqmoc9sj=>

Step 3: To get a sense of your schema, list all the tables you're syncing to your database by typing the command \dt:

dbh2vw0hqmoc9sj=> \dt

               List of relations
 Schema |        Name        | Type  |  Owner
--------+--------------------+-------+----------
 public | _sync_event        | table | postgres
 public | _sync_event_cursor | table | postgres
 public | _sync_write_log    | table | postgres
 public | account            | table | postgres
 public | contact            | table | postgres
 public | lead               | table | postgres
 public | opportunity        | table | postgres
 public | user_              | table | postgres
(8 rows)

You'll see all the Salesforce objects you selected when setting up your sync are now tables in your database. You'll also see three _sync tables which Sequin uses to manage your sync.

Step 4: Write your first query. You can start with a simple select to get your bearings:

dbh2vw0hqmoc9sj=> select count(*) from contact;

 count
-------
    15
(1 row)

Now, pull the contact api_id, first_name, and last_name for a specific customer to use in the next step:

dbh2vw0hqmoc9sj=> select api_id, first_name, last_name from contact where email = 'eric@sequin.io';
       api_id       | first_name | last_name
--------------------+------------+-----------
 0038V00002ZBQ8pQAH | Eric       | Goldman
(1 row)

Great, you can now use this api_id in the last step of this setup guide.

Write to Salesforce using the Sequin Proxy

To create, update, or delete objects in Salesforce, you'll write to the Salesforce API through the Sequin Proxy.

When you write through the Sequin Proxy, both Salesforce and your database update simultaneously. Additionally, Sequin will queue and batch your calls automatically to ensure you never need to think about the Salesforce rate limit.

In this example, you'll update the contact in the prior step by giving them a new first and last name.

Step 1: Find your sync's unique Proxy base URL in the Sequin Console by clicking on the Proxy writes button on your sync card. Copy the proxy URL:

Step 2: With your proxy base URL in hand, you can now construct a cURL command to update the contact.

Open a new tab in your terminal so you can return to psql in the next step.

You'll structure the PATCH request exactly as you would if you were using the Salesforce REST API directly. The only difference is you'll prepend the base URL with the Sequin Proxy prefix:

curl https://proxy.sequin.io/{{your_sync_id}}/{{your_salesforce_subdomain}}.my.salesforce.com/services/data/v57.0/sobjects/Contact/{{contact_id_from_prior_step}} \
  -H 'Authorization: Bearer {{your_access_token}}' \
  -H "Content-Type: application/json" \
  -d '{"FirstName": "Sequin","LastName": "Setup"}' \
  -X PATCH

This call will update the first and last name of contact 0038V00002ZBQ8pQAH. The empty response indicates that the update was successful!

Step 3: Now, confirm the change in your database. Go back to psql and check the contact you just updated:

dbh2vw0hqmoc9sj=> select first_name, last_name from contact where api_id='0038V00002ZBQ8pQAH';

 first_name | last_name
------------+-----------
 Sequin     | Setup
(1 row)

Great, Salesforce and your database were updated in real-time.

Next steps

Salesforce and your database are now syncing in real-time. You can query for all your data using SQL and mutate data via the Sequin Proxy. To build on this foundation, here are some next steps:

• Setup your ORM to work with your synced tables.
• Edit the Salesforce objects and properties you're syncing at any time.
• Create views on your Salesforce data to tailor your schema to your needs.
• Invite your team to your Sequin account and start building!

If you need assistance setting up your sync, just send us a note. We're around and would and eager to help.