Salesforce

{/* Generated by scripts/generate-integration-catalog.mjs. Do not edit by hand. */}

At a glance

  • Availability: Experimental (how to enable).
  • Authentication: OAuth 2.0.
  • Connection: A user authorizes the connection in the provider's consent screen.
  • Scopes: api, refresh_token, offline_access.

Credentials

Set these per environment. See Connect an integration.

These variables are required only when you supply your own OAuth app. If a managed app is available, you can connect without setting them. Provider permissions and consent still apply.

VariableRequiredDescription
SALESFORCE_CLIENT_IDNoOptional: consumer key of your own Salesforce OAuth app. Hosted Veryfront uses the installed Veryfront package instead. Docs.
SALESFORCE_CLIENT_SECRETNoOptional: consumer secret of your own Salesforce OAuth app Docs.
SALESFORCE_SERVICE_ACCOUNT_CLIENT_IDNoService account: consumer key of an External Client App that uses the Client Credentials Flow. Set it together with the secret and login URL. Docs.
SALESFORCE_SERVICE_ACCOUNT_CLIENT_SECRETNoService account: consumer secret of the Client Credentials Flow app Docs.
SALESFORCE_SERVICE_ACCOUNT_LOGIN_URLNoService account: the org's My Domain origin, for example https://acme.my.salesforce.com. Generic login hosts are rejected. Docs.

Setup

  1. Choose how Veryfront reaches Salesforce: Per-user OAuth acts as each connected Salesforce user; hosted Veryfront provides the OAuth app through the Veryfront Salesforce Integration package, so no environment variables are needed. A service account runs scheduled or project-owned automation as a dedicated integration user without browser consent.
  2. Install the Veryfront package: As a Salesforce administrator, install the Veryfront Salesforce Integration beta package in each org users connect, choosing Install for Admins Only. Salesforce rejects authorization from an org without it. Try a sandbox or test org first.
  3. Enable the Veryfront app: In Setup, open External Client App Manager, select Veryfront and confirm it is Packaged (Installed) and Enabled. Under Policies, restrict the permitted users to the profiles or permission sets that should connect.
  4. Connect a Salesforce user: In Veryfront, start the Salesforce connection from the project's integrations, sign in to the org where the package is installed and approve consent. No integration policy is needed before the first call. Only when you use your own OAuth app instead of the package, register https://api.veryfront.com/oauth/callback/salesforce as its callback URL and set SALESFORCE_CLIENT_ID and SALESFORCE_CLIENT_SECRET.
  5. Or configure a service account: Create a dedicated integration user with the least object, field and API permissions the tools need, and an External Client App with the Client Credentials Flow, the api scope and that user as Run As user. Set SALESFORCE_SERVICE_ACCOUNT_CLIENT_ID, SALESFORCE_SERVICE_ACCOUNT_CLIENT_SECRET and SALESFORCE_SERVICE_ACCOUNT_LOGIN_URL (the org's My Domain origin). All three are required in this mode; if one is missing, runs fail closed instead of falling back to a user connection.
  6. Verify access: Run Find Customer (read-only). With its default query it returns the most recently changed contacts and their accounts from the target org without changing them. For a service account, confirm the Salesforce audit trail attributes the request to the integration user.

Provider notes

  • The user connection requests api, refresh_token and offline_access.
  • Non-interactive runs can use a service account instead of a user connection: set SALESFORCE_SERVICE_ACCOUNT_CLIENT_ID, SALESFORCE_SERVICE_ACCOUNT_CLIENT_SECRET and SALESFORCE_SERVICE_ACCOUNT_LOGIN_URL (the My Domain origin) from an External Client App that uses the Client Credentials Flow with a dedicated Run As user. All three are required; see https://veryfront.com/docs/code/guides/integrations/salesforce#use-a-service-account
  • Tools that create, update or delete records are marked as writes and need write authority; the other tools are read-only.

Provider API reference.

Project configuration

Project integration configuration is optional. When config is missing or {}, Salesforce tools keep the default compatibility behavior. New Studio saves use the object-first shape below; older allowedSObjects, allowExpertSoql, and maxQueryRows configs are still accepted during migration.

FieldTypeDefault in the Studio formRuntime effect when saved
dataAccess.objectsArray of Salesforce object API namesAccount, Contact, Case, CaseComment, KnowledgeArticleVersion, plus objects required by currently selected toolsRestricts Salesforce tools to selected objects. Custom and managed-package objects such as Customer__c or ns__Subscription__c can be added by API name. Omit it or use an empty list to avoid a project-level object filter. Salesforce permissions still apply.
capabilities.allowExpertSoqlBooleanfalseAllows the raw run_soql_query expert path only when the tool is also explicitly enabled in the project tool list.
capabilities.maxQueryRowsInteger from 1 to 2000100Rejects SOQL queries whose top-level LIMIT is above this value. Omit it to avoid a project-level row limit.
mappings.customer, mappings.contact, mappings.case, mappings.knowledgeOptional mapping objectsAccount/contact/case/knowledge defaultsRecords how this org maps Veryfront concepts to Salesforce objects, identity fields, display fields, and relationships. These fields store mapping metadata; they do not automatically rewrite individual tool queries.

Recommended Service Cloud support config:

json
{
  "dataAccess": {
    "objects": [
      "Account",
      "Contact",
      "Case",
      "CaseComment",
      "KnowledgeArticleVersion"
    ]
  },
  "capabilities": {
    "allowExpertSoql": false,
    "maxQueryRows": 100
  },
  "mappings": {
    "customer": { "object": "Account", "identityFields": ["Name"], "displayField": "Name" },
    "contact": { "object": "Contact", "identityFields": ["Email", "Name", "Phone"], "displayField": "Name" },
    "case": { "object": "Case", "customerRelationship": "AccountId", "displayField": "CaseNumber" },
    "knowledge": { "object": "KnowledgeArticleVersion" }
  }
}

Enable write tools separately with the project tool allowlist. For example, select create_case, add_case_comment, or update_case only for agents that need to change Salesforce records.

Tools

ToolAccessDescription
Find Customer<br /><code className="reference-identifier">salesforce__find_customer</code>ReadFind customer
Search Accounts<br /><code className="reference-identifier">salesforce__search_accounts</code>ReadSearch accounts
Get Account<br /><code className="reference-identifier">salesforce__get_account</code>ReadGet account
Search Contacts<br /><code className="reference-identifier">salesforce__search_contacts</code>ReadSearch contacts
Get Contact<br /><code className="reference-identifier">salesforce__get_contact</code>ReadGet contact
List Cases<br /><code className="reference-identifier">salesforce__list_cases</code>ReadList cases
Get Case<br /><code className="reference-identifier">salesforce__get_case</code>ReadGet case
List Case Activity<br /><code className="reference-identifier">salesforce__list_case_activity</code>ReadList case activity
Search Knowledge Articles<br /><code className="reference-identifier">salesforce__search_knowledge_articles</code>ReadSearch knowledge articles
List Opportunities<br /><code className="reference-identifier">salesforce__list_opportunities</code>ReadList opportunities
Create Lead<br /><code className="reference-identifier">salesforce__create_lead</code>WriteCreate lead
Create Case<br /><code className="reference-identifier">salesforce__create_case</code>WriteCreate case
Add Case Comment<br /><code className="reference-identifier">salesforce__add_case_comment</code>WriteAdd case comment
Update Case<br /><code className="reference-identifier">salesforce__update_case</code>WriteUpdate case
Describe Object<br /><code className="reference-identifier">salesforce__describe_object</code>ReadDescribe object
Run SOQL Query<br /><code className="reference-identifier">salesforce__run_soql_query</code>ReadRun read-only SOQL query

Verify the connection

Call a read tool such as salesforce__find_customer with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.