Salesforce
Integrate Apten with Salesforce.
Overview
Connect your Apten account with Salesforce to sync information about leads and SMS conversations in Apten with any Salesforce object. Currently, we support syncing:
- Tags: sync tags into a custom field in Salesforce.
- Summaries: sync lead conversation summaries into a custom field in Salesforce.
- Variables: map variables to custom fields in Salesforce, which will sync in real-time.
Step 1: Create an Integration User in Salesforce
-
Log in to Salesforce as an administrator
-
Navigate to Setup > Users > New User
-
Fill in the required fields:
- First Name: Apten
- Last Name: Integration
- Email: [email for the integration user]
- Username: [unique username for integration]
- Role: [assign an appropriate role]
- User License: Salesforce Integration
- Profile: Salesforce API Only System Integrations
-
Click “Save” to create the Integration User
Step 2: Create a Permission Set in Salesforce
-
Navigate to Setup > Permission Sets > New
-
Create a new Permission Set:
- Label: Apten Integration Permissions
- API Name: Apten_Integration_Permissions
-
Click “Save” to create the Permission Set
-
Configure the Permission Set:
- Under “System Permissions”, enable:
- API Enabled
- Modify All Data
- Customize Application (so that Apten can set-up custom fields)
- Under “Object Settings”, enable:
- Read, Create, Edit permissions the object that you want to sync with Apten (e.g., Lead, Contact, etc.), along with any fields on that object that you want to sync.
- Under “System Permissions”, enable:
-
Assign the Permission Set to the Integration User:
- Go to Setup > Permission Sets
- Click on the “Apten Integration Permissions” Permission Set
- Click “Manage Assignments”
- Click “Add Assignments”
- Select the Apten Integration User
- Click “Assign”
Step 3: Connect Apten to Salesforce
- In Apten, go to Integrations
- Click Connect on the Salesforce card
- Authorize with the email and password for the Salesforce Integration User
- Click Connect
- Select the object that you want to sync with Apten (e.g., Lead, Contact, etc.), and click Save (you won’t be able to change this later).
- If you’d like to sync Tags or Summaries, click the Set up button next to the relevant section.
- This will create a custom field on the object in Salesforce (Apten_Tags__c, Apten_Summary__c) and enable syncing.
- Important: You MUST remember to update your permission set in Salesforce to include the new custom field, or syncing will fail.
Step 4: Map Variables (Optional)
When setting up variables in customer profiles in Build & Test, you can map them to Salesforce fields.
These fields will automatically sync to Salesforce in real-time when Apten talks to a lead.
Step 5: Import Leads with Salesforce IDs
When importing leads into Apten, you must set the following fields:
integrationSource
: Set this to'salesforce'
to indicate the lead is from SalesforcesalesforceId
: Set this to the Salesforce object ID of the lead (e.g. ‘00Q1a000004XYZ’)
Example payload: