Overview
Supported resources
Connect setup
Salesforce uses OAuth 2.0 with an External Client App. You can optionally configure JWT Bearer for server-to-server authentication.1
Create an External Client App in Salesforce
Go to Salesforce Setup → search External Client App Manager in Quick Find → click New. Fill in the app name and contact email. Set Distribution State to Packaged. Expand the API (Enable OAuth Settings) section and enable OAuth.
2
Add the redirect URL
In the Callback URL field, add:
3
Configure OAuth scopes
Add the following scopes to Selected OAuth Scopes:
Manage user data via APIs (api)Perform requests at any time (refresh_token, offline_access)
4
Get your Consumer Key and Secret
After saving, click Consumer Key and Secret in the OAuth Settings section. Copy both values — you’ll need them in the Connect widget.
5
Connect via the widget
When your end user opens the Connect widget, they select Production or Sandbox environment, enter the Consumer Key and Consumer Secret, then authorize via Salesforce.
Usage
Notes
- Salesforce uses SOQL queries internally — listing operations select specific fields rather than returning all properties.
- The
instance_urlis stored per connection and used for all API calls (each Salesforce org has a unique URL). - Notes are mapped to the classic Salesforce Note object. A
contentand parent record (contact,account, oropportunity) are required when creating notes. - Pipeline is read-only — stages come from the OpportunityStage metadata object.
- Use
environment: "sandbox"in your connect token to connect sandbox orgs viatest.salesforce.com. - Salesforce requires
LastNamefor contacts and leads,Name+StageName+CloseDatefor deals.