Salesforce CRM
At this time, Arcade does not offer a default Salesforce Auth Provider. To use Salesforce auth and toolkit, you must create a custom Auth Provider with your own Salesforce OAuth 2.0 credentials as documented in Salesforce Auth Provider.
Description: Enable agents to interact with accounts, leads, contacts, etc in the Salesforce CRM.
Author: Arcade
Code: GitHub
Auth: OAuth 2.0
The Arcade Salesforce CRM toolkit provides a pre-built set of tools for interacting with Accounts, Leads, Contacts, etc in the Salesforce CRM. These tools make it easy to build agents and AI apps that can:
- Search for Accounts and Contacts by keywords or retrieve them by ID
- Read information about Accounts, such as company metadata, opportunities, deals, etc.
- Read information about Contacts, such as name, email addresses, phone numbers, email messages, call logs, notes, meetings, tasks, etc.
- Create contacts
Install and Run the Arcade Engine
At this time, you need to self-host the Arcade Engine to use the Salesforce toolkit. Follow the step-by-step instructions in the Salesforce Auth Provider page.
Install
pip install arcade_salesforceAvailable Tools
| Tool Name | Description |
|---|---|
| GetAccountDataByKeywords | Searches for accounts in Salesforce and returns them with related info: contacts, leads, notes, calls, opportunities, tasks, emails, and events. |
| GetAccountDataByID | Gets the account with related info (contacts, leads, notes, calls, etc). |
| CreateContact | Creates a contact in Salesforce associated with an account. |
If you need to perform an action that’s not listed here, you can get in touch with us to request a new tool, or create your own tools.
In order to use the Salesforce toolkit, you must self-host the Arcade Engine and configure the Salesforce auth provider. The Arcade Engine is available at http://localhost:9099 by default. In the code examples below, if necessary, adjust the base_url (in Python) or baseURL (in JavaScript) parameter in the Arcade client constructor to match your environment.
GetAccountDataByKeywords
Searches for accounts in Salesforce and returns them with related info: contacts, leads, notes, calls, opportunities, tasks, emails, and events (up to 10 items of each type).
Parameters
- query (string, required) The query to search for accounts. MUST be longer than one character. It will match the keywords against all account fields, such as name, website, phone, address, etc. E.g. ‘Acme’.
- limit (int, optional, Defaults to
10) The maximum number of accounts to return. Defaults to 10. Maximum allowed is 10. - page (string, optional) The page number to return. Defaults to 1 (first page of results).”
GetAccountDataById
Gets the account with related info: contacts, leads, notes, calls, opportunities, tasks, emails, and events (up to 10 items of each type).
Parameters
- account_id (string, required) The ID of the account to get data for.
CreateContact
Creates a contact in Salesforce associated with an account.
Parameters
- account_id (string, required) The ID of the account to create the contact for.
- first_name (string, required) The first name of the contact.
- last_name (string, required) The last name of the contact.
- email (string, required) The email address of the contact.
- phone (string, optional) The phone number of the contact.
- mobile_phone (string, optional) The mobile phone number of the contact.
- title (string, optional) The title of the contact. E.g. ‘CEO’, ‘Sales Director’, ‘CTO’, etc.
- department (string, optional) The department of the contact. E.g. ‘Marketing’, ‘Sales’, ‘IT’, etc.”.
- description (string, optional) A description of the contact.
Self-hosting the Arcade Engine with Salesforce Auth
At this time, Arcade Cloud does not support Salesforce auth.
In order to use the Salesforce toolkit (or develop custom tools for Salesforce), you have to self-host the Arcade Engine and configure the Salesforce auth provider in your engine configuration.