Salesforce: what this connector can do

Member·5 minutes to read

What this page is for

docs/connectors/salesforce.md is the setup guide for whoever runs your organisation's Botseon deployment — creating the vendor application and entering its credentials. This page is the other half: what Salesforce actually lets a bot do once it is connected to your account, what it asks you for along the way, its limits, and how to take the connection away again, in Botseon and at Salesforce.

Query, read and search records, list the standard and custom objects you can read and their fields, and create or change one record.

What a bot can do with it

Read — Salesforce tells a bot things, nothing changes

ToolWhat it does
salesforce.soql_queryRun a SOQL query that states its LIMIT.
salesforce.get_recordRead one record by its id.
salesforce.search_recordsSearch records across objects.
salesforce.list_objectsList the objects you can read, standard and custom, with labels and API names.
salesforce.describe_objectList one object’s fields you can see, with types and whether you may edit them.

Describing an object also names how it links to others: a lookup field's relationship name (Account__r on an Invoice) and the objects that point back at it (an Account's Contacts), so a bot can ask for an Invoice with its Account's name in one query. Salesforce leaves out any field you cannot see, and the bot never adds one back.

Write — Salesforce lets a bot change things

ToolWhat it does
salesforce.create_recordCreate one record.
salesforce.update_recordChange one record’s fields.

Connecting it

Open Plugins, find Salesforce and press Add. On its card, fill in Salesforce instance — the first part of your Salesforce address: for https://acme.my.salesforce.com enter acme, for a Developer Edition at https://acme-dev-ed.develop.my.salesforce.com enter acme-dev-ed.develop. Then press Authenticate and sign in to Salesforce as yourself.

A bot sees exactly what you see in Salesforce: your profile, permission sets and sharing rules decide which objects, records and fields it can read or change. Your Salesforce edition must include API access (Enterprise Edition and up, or Pro Suite with the API add-on); on Starter Suite or Free Suite the connection is refused by Salesforce.

Creating or changing a record always shows you an approval card first, naming the object or the record, unless you have told Botseon to always allow that exact action.

The permissions it asks for, in plain words

Every call a bot makes through this connector is tagged with what kind of thing it is. Only the tags below ever apply here — a tag this connector's tools never carry is not listed, because it can never ask you for it.

  • read — Looks something up. Nothing changes, and nothing is sent anywhere. A bot never has to ask first for this.
  • write — Changes something inside the connected account — creates, edits or files something. Asks you first, unless you have told Botseon to always allow that exact action.

Limits

Query, read and search records, list the standard and custom objects you can read and their fields, and create or change one record. Nothing outside that list is possible through this connector, however a bot is asked to use it.

Salesforce is also only ever as wide as the scopes your organisation's connected app actually requests — the exact scopes are on the operator's own setup page, docs/connectors/salesforce.md, because narrowing or widening them is a decision for whoever runs your deployment, not for this page.

Disconnecting

In Botseon

Open Plugins from the sidebar, press this connector's card to open its detail page, and under Accounts press the ✕ next to the account (its label is "Remove account" and the name of the account), then Revoke and remove to confirm — or Uninstall to remove the plugin and every account connected to it at once. Either one revokes the stored connection immediately: nothing more is read or changed through it from that moment on. Install a plugin walks through the same screen step by step.

At Salesforce

Removing the account in Botseon also asks Salesforce to revoke the token, when this deployment's connector is configured with a revoke URL. Confirm the grant is actually gone by opening Salesforce's own account settings — the connected-apps, security or authorised-apps page covers it — and removing Botseon there too if it still shows up. That is also where you can revoke access without going through Botseon at all, which is worth knowing if you ever lose access to your Botseon account.

What Botseon keeps, and how your data is used

Whatever a bot reads or writes through this connector becomes part of your conversations and the record of that run — the same records, and the same retention schedule, as everything else a bot works on. Botseon is the processor for that content; your organisation decides what it may read and remember, and can delete it sooner than the schedule would on its own.

Your data is sent to a model provider only to produce the bot's answer, and for nothing else — it is not used to train any model. The Privacy Policy's Models and How long we keep it sections have the full detail, including exactly how long each kind of record is kept for.

See also

Last verified against build ad93750.