botpress--botpress/integrations/salesforce/hub.md

The Salesforce integration allows you to search, create, update, and delete Salesforce objects (contacts, leads, cases) and make direct API requests.

Integration Setup

1. Install the Integration
2. Click the Authorize or Connect with OAuth button to authorize with Salesforce and complete the installation process.
3. To use Salesforce's Sandbox environment instead, select the Sandbox configuration type before connecting.

How-To

Make API request

1. Make API Request action acting as a proxy allowing users to make request to the Salesforce API.
2. Pass valid HTTP method, URL path ("yourinstance.salesforce.com/services/data/v54.0/PATH"), and additional request data if needed.

Search Contacts

1. In Studio, add the Search Contacts card to your flow.
2. Pass at least one search criteria in the card input.
3. You can store the result of the action in a variable.

Create Contact

1. In Studio, add the Create Contact card to your flow.
2. Pass the contact information in the card input. First Name, Last Name, Email fields are required.
3. You can pass custom fields in JSON format
4. You can store the Id of the created contact in a variable.

Update Contact

1. In Studio, add the Update Contact card to your flow.
2. Pass the Id of the contact to be updated and the field that need to be updated
3. You can pass custom fields in JSON format
4. You can store the Id of the updated contact in a variable.

Search Leads

1. In Studio, add the Search Leads card to your flow.
2. Pass at least one search criteria in the card input.
3. You can store the result of the action in a variable.

Create Leads

1. In Studio, add the Create Leads card to your flow.
2. Pass the contact information in the card input. First Name, Last Name, Email, Company fields are required.
3. You can pass custom fields in JSON format
4. You can store the Id of the created contact in a variable.

Update Leads

1. In Studio, add the Update Leads card to your flow.
2. Pass the Id of the contact to be updated and the field that need to be updated
3. You can pass custom fields in JSON format
4. You can store the Id of the updated contact in a variable.