Provider guides
Salesforce
What’s Supported
Supported Actions
The Salesforce connector supports:- Read Actions, including full historic backfill and incremental read.
- Subscribe Actions.
- Write Actions, including Bulk Write.
- Proxy Actions, using the base URL
https://{{.workspace}}.my.salesforce.com.
Supported Objects
The Salesforce connector supports writing to and reading from the following objects:- Account
- Contact
- Lead
- Opportunity
- Case
- Task
- Event
- Campaign
- Product
- User
- All other standard objects
- All custom objects
- Standard fields
- Custom fields
Example Integration
For an example manifest file of a Salesforce integration, visit our samples repo on Github.Before You Get Started
To integrate Salesforce with Ampersand, you need to Create a Salesforce Account and obtain the following credentials from a Salesforce Connected App:- Consumer Key
- Consumer Secret
Create a Salesforce Account
You need a Salesforce account to create integrations using Ampersand. If you do not have a Salesforce account, here’s how you can sign up for a free Developer Account:- Go to the Salesforce Developer site and sign up for a free developer account.
- Fill in the required details and click on Sign Me Up.
- Verify your email and complete the registration process.
Create a Salesforce Connected App
To create Salesforce integrations with Ampersand, you’ll need to first create a Connected App in Salesforce. Follow the steps below:- Log in to your Salesforce account.
-
Navigate to the gear icon in the top right corner and select Setup.
-
Go to Platform Tools >> Apps >> App Manager.
-
Click New Connected App to create a new app.
- Enter Connected App Name, API Name, and Contact Email.
-
Select the Enable OAuth Settings checkbox to configure the OAuth settings:
-
Enter the Callback URL:
https://api.withampersand.com/callbacks/v1/oauth - Select the applicable OAuth Scopes from the list and click Add. You must always include the following scopes:
-
Perform requests at any time (
refresh_token,offline_access) -
Manage user data via APIs (
api)
✅ For more details on which OAuth scopes to include, refer to the OAuth Tokens and Scopes guide.
-
Uncheck the Require Proof Key for Code Exchange (PKCE) Extension for Supported Authorization Flows checkbox.
-
Enter the Callback URL:
- Click Save.
Obtain Consumer Key and Consumer Secret
Now that you have created a Connected App in Salesforce, you can obtain your Consumer Key and Consumer Secret. These credentials will be used in the next step, where you will connect your application to Ampersand . In the Platform Tools >> Apps >> App Manager section, find your newly created connected App and follow the steps below to obtain Consumer Key and Consumer Secret.- Click the dropdown arrow next to your app and select View.
- Click Manage Consumer Details.
- Complete the verification and you will be able to access the Consumer Key and Consumer Secret.
Provide Salesforce Connected App info to Ampersand
- Log in to your Ampersand Dashboard.
-
Select the project where you want to create a Salesforce integration.
- Select Provider apps.
- Select Salesforce from the Provider list.
-
Enter the previously obtained Consumer Key in the Client ID field and the Consumer Secret in the Client Secret field.
ℹ️ If you lose these keys, you can regenerate them by editing the Connected App in Salesforce and selecting Regenerate Consumer Secret.
Using the connector
To start integrating with Salesforce:- Create a manifest file like the example.
- Deploy it using the amp CLI.
- If you are using Read Actions or Subscribe Actions, create a destination.
- Embed the InstallIntegration UI component.
- Start using the connector!
- If your integration has Read Actions or Subscribe Actions, you’ll start getting webhook messages.
- If your integration has Write Actions, you can start making API calls to our Write API.
- If your integration has Proxy Actions, you can start making Proxy API calls.