Allow Breakout to access Salesforce so that Breakout read and write CRM records, resolve accounts and contacts, and support workflows that depend on Salesforce data.
Important: Use Salesforce Sandbox instead of Salesforce when you want to test against a sandbox org.
Follow these instructions to allow Breakout to access Salesforce Sandbox.
Prerequisites
Use a Salesforce user with the permissions required for the workflows your workspace will run.
Read-only workflows usually need object read access.
Workflows that export or update data need to create or update access for the destination objects and fields.
Confirm that you are connecting to a production Salesforce org.
If your Salesforce admin controls connected apps, ask them to approve the Breakout connected app before you connect.
Supported authentication methods
Salesforce can be connected in one of two ways:
Method | Best for |
Admins or integration users who can sign in interactively and approve the app. | |
Server-to-server access through a Salesforce execution user with API permissions |
OAuth sign-in method
Click Integrations and then toggle the switch on in the Salesforce card
Allow the Salesforce sign-in window to open
Sign in to the correct Salesforce production org
Review and approve the requested permissions
Permission | Salesforce label | Why Breakout needs it |
api | Manage user data via APIs | Read and write Salesforce records through Salesforce APIs according to the connected user's permissions. |
refresh_token | Perform requests at any time | Maintain the connection without asking the user to sign in before every workflow run. |
Return to Breakout and wait for the Salesforce integration to show as Connected. It may take a few minutes for the status to update on the Integrations page.
If the Salesforce approval window closes but the integration still doesn't show as connected, refresh the Integrations page.
If Salesforce still appears as Disconnected, reconnect the integration and make sure you complete the Salesforce approval process successfully.
Consumer credentials method
Use this method only if your Salesforce admin has created a connected app for server-to-server access.
Click your name to navigate to Settings
Click Integrations and then toggle the switch on in the Salesforce card. The Salesforce integration window opens.
Enter the following details and click Continue.
Field | What to enter |
Consumer key | Consumer key associated with the connected app |
Consumer secret | Consumer secret associated with the connected app |
Token URL | The Salesforce OAuth token endpoint for the org, for example https://your-domain.my.salesforce.com/services/oauth2/token. |
Use an HTTPS Salesforce token URL. Your Salesforce My Domain URL is available in Salesforce Setup under My Domain.
Return to Breakout and wait for the Salesforce integration to show as Connected. It may take a few minutes for the status to update on the Integrations page.
If the Salesforce approval window closes but the integration still doesn't show as connected, refresh the Integrations page.
If Salesforce still appears as Disconnected, reconnect the integration and make sure you complete the Salesforce approval process successfully.
Creating a Salesforce connected app for client credentials
A Salesforce admin should complete these steps:
In Salesforce, go to Setup.
In Quick Find, search for App Manager.
Click New Connected App.
Enter Connected App Name: Breakout Integration.
Enter API Name: Breakout_Integration.
Enter a contact email for your IT or integration admin.
Select Enable OAuth Settings.
In Callback URL, enter https://dashboard.getbreakout.ai/tenant/integration/oauth2/callback.
In Selected OAuth Scopes, add Manage user data via APIs (api).
Save the connected app.
Enabling the client credentials flow
In App Manager, find the connected app and select Edit.
Under API (Enable OAuth Settings), select Enable Client Credentials Flow.
Save the connected app.
Open the connected app detail page and click Manage.
Click Edit Policies.
Under Client Credentials Flow, set Run As to the Salesforce execution user.
Choose a user with API access. A dedicated API-only integration user is recommended.
Save the policy.
Verifying the connection
Salesforce should show as connected on the Integrations page in Breakout. Workflows that use Salesforce should be able to complete the following tasks:
Look up records
Create tasks or events
Export mapped objects based on the connected user's permissions
If a workflow fails after connection, check the following for each Salesforce user:
Object permissions
Field-level security
Required fields
Validation rules
Duplicate rules
Disconnecting or reconnecting Salesforce
Disconnect Salesforce in these cases:
Connected the wrong org
Need to rotate credentials
Want to switch users
Reconnect with the correct Salesforce user or client credentials on the Integrations page in Breakout