Skip to main content
When you’re done, the BotShield → Setup tab shows a green health checklist and both rails are ready to use.
You’ll need your agent key (bs_agent_…, shown once when an Admin registers an agent under Agents Ask → Trusted Agents in console.botshield.ai) and, optionally, a read-only API key (from Settings → Developer Tools → API Keys). Keep them handy for step 3.

1. Install the package

Install BotShield from AgentExchange into your org (production or sandbox). After install, open the App Launcher and choose BotShield — you’ll land on the Home tab, whose health pill counts how many setup checks are ready.

2. Assign permission sets

Assign the permission sets to the users who need them (Setup → Permission Sets, or the People section of the BotShield Setup tab):

3. Connect your Console keys

BotShield calls the BotShield API over Named Credentials — no keys are stored in code or metadata.
1

Set the agent key

Go to Setup → Named Credentials → External Credentials → BotShield Agent (Default) (BotShield_Agent_Default). On the principal Agent, add the authentication parameter AgentKey with your agent key as its value. This authorizes the Agents Ask rail. Use a production agent’s key for a production org; registering a production agent needs an Admin’s Developer passkey in the Console.
2

Set the Admin API key (optional)

On the BotShield Admin API External Credential (BotShield_Admin_API), principal Org, add the parameter OrgKey with a read-only API key (admin:read). Then turn on Admin API Enabled in Custom Metadata → BotShield Setting → Default. This lets the app sync your gates and agents automatically. Without it, everything still works — you just add gates manually.
3

Choose your environment

The package points at the BotShield API. Development and production keys use the same host; the key decides the environment. The BotShield Setup tab shows which environment is in use.

4. Connect the Console and choose what pushes

This is where you tell BotShield to write verifications and resolutions back into your org. In the Console, open Settings → Integrations — the list of platforms that receive BotShield Gate results and Agents Ask resolutions — and find the Salesforce card. It’s two steps: connect, then configure targets.
BotShield Console Settings → Integrations, showing the Salesforce card

Settings → Integrations — the platforms that receive BotShield Gate results and Agents Ask resolutions.

4a. Connect your org

Click Connection on the Salesforce card. BotShield authenticates to your org with Connected App credentials (OAuth client-credentials flow) — one org per environment.
1

Pick the environment

Choose the Development or Production tab. Development receives your sandbox / Developer Edition events; Production, your production org.
2

Enter the Connected App credentials

Paste your org’s Instance URL, Consumer Key, and Consumer Secret — from the External Client App in your Salesforce org. The BotShield Setup tab’s Data push section walks you through creating it: OAuth enabled, api scope, client-credentials flow, Run-As an integration user holding the BotShield_Integration permission set. Secrets are stored server-side and never shown again.
3

Test and save

Click Test Connection. A green result means the Console can reach your org through the Run-As user. Save, then flip Enable Salesforce Integration on.
Salesforce Connection modal with Instance URL, Consumer Key and Secret, and Test Connection

Salesforce Connection — Connected App credentials (OAuth client-credentials), per environment.

4b. Choose which Gates and Agents push

Back on the Salesforce card, click Configure. You’ll see a two-column picker — Available on the left, Pushing to Salesforce on the right — with the same Development / Production toggle. Move the gates and agents you want writing into your org to the right-hand column:
  • BotShield Gates write verification outcomes to BotShield_Gate__c.
  • Agents Ask agents write approval outcomes to BotShield_Resolution__c.
Changes apply immediately — a target starts (or stops) pushing on its next terminal event.
Salesforce Enabled Deployments & Agents dual-list picker

Configure — move Gates and Agents into “Pushing to Salesforce.”

The Salesforce integration is one org per environment. Point Production at your production org and Development at your sandbox — don’t cross them, or pushed records land in the wrong place.
The managed-package push requires the BotShield AgentExchange package installed in the org. You can connect and pick targets now; pushes start once the package is installed.

5. Verify

Open BotShield → Setup and click Re-check (with callouts). Each row turns green as its prerequisite is met — keys set, run-as user assigned, last row received. When the health pill reads all-ready, you’re set.

Next steps

Human Verification on Experience Cloud

Gate an Experience Cloud checkout or form.

Agents Ask in Agentforce

Require human confirmation for agent actions.

Agents Ask in Flow

Pause a Flow for a human approval.

Link a human

How a person links to your agent in the BotShield app so they can be asked.