Salesforce Spoke
The Salesforce spoke is built by Bristlecone, Inc. Access and manage data in the Account, Contact, Case, Lead, Opportunity, Order, and User objects of your Salesforce instance from the ServiceNow instance.
Request apps on the Store
Visit the ServiceNow Store to view all the available apps, and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.
Integration Hub subscription
This spoke requires an Integration Hub subscription. For more information, see Legal schedules - IntegrationHub overview.
Spoke version
Salesforce spoke v2.5.0 is the latest version.
Supported version
This spoke was built for the Salesforce API version v64.0, but may be compatible with later versions.
Spoke requirements
- Salesforce account
- Salesforce admin credentials
- Salesforce connected app configured to integrate with ServiceNow
- Salesforce connected app details such as, consumer key and consumer secret.
- Integration Hub subscription
Note: For users who have installed Salesforce spoke v1, you can't upgrade from Salesforce spoke v1 to Salesforce spoke v1.2 directly. To upgrade, you must uninstall the Salesforce spoke v1 and then, install the Salesforce spoke v1.2.
You must also note that, Salesforce spoke v1 is certified on New York and Salesforce spoke v1.2 is certified on Orlando and Paris.
Spoke subflows
The Salesforce spoke provides subflows to access and manage data in the Salesforce Account, Case, Contract, and Opportunity objects.
| Subflow | Description |
|---|---|
| Account Subflow | Processes data in the account object when the Salesforce webhook is triggered. |
| Case Subflow | Processes data in the case object when the Salesforce webhook is triggered. |
| Contract Subflow | Processes data in the contract object when the Salesforce webhook is triggered. |
| Opportunity Subflow | Processes data in the opportunity object when the Salesforce webhook is triggered. |
| Salesforce Subflow | Processes data in any Salesforce object when the Salesforce webhook is triggered. |
Spoke actions
The Salesforce spoke provides actions to access and manage data in the Salesforce , Account, Contact, Case, Lead, Opportunity, Order, and User objects.
| Category | Action | Description |
|---|---|---|
| Account Management | Create Account | Creates an account in Salesforce. |
| Look up Accounts | Retrieves all the account details based on the specified SOQL query. | |
| Look up Records for Account | Retrieves all the records for an account based on the given relationship name. | |
| Record Management | Create Record | Creates a record in Salesforce.Note: Ensure that you use relevant actions to create records for Account, Contact, Case, Lead, Opportunity, Order, and User. |
| Delete Record | Deletes a record in Salesforce. | |
| Get Record Details | Retrieves the specific record in Salesforce by Record ID. | |
| Look up Attachment from Records | Retrieves an attachment from a record if it was uploaded using the Salesforce Classic view. | |
| Look up Contracts | Retrieves all the contract details based on the specified SOQL query. | |
| Look up Related Records | Retrieves all the records for the specified object name associated with their given relationship name. | |
| Subflow Helper Action | Parses the subflow's JSON input and generates an array of object. | |
| Update Record | Updates a record in Salesforce. | |
| Look up Document from Record | Retrieves a document from a record if it was uploaded using the Salesforce Lightning view. | |
| Case Management | Create Case | Creates a case in Salesforce. |
| Lead Management | Create Lead | Creates a lead in Salesforce. |
| Metadata Retrieval | Metadata - Check Service Cloud Feature | Checks whether Salesforce Service Cloud is enabled on the target Salesforce instance. To use this action, perform the steps outlined in the Create a Salesforce CRM integration profile section in Integrating with Salesforce CRM. |
| Metadata - Get Account Types | Retrieves all the available account types in Salesforce. | |
| Metadata - Get Creatable Fields | Retrieves a list of creatable fields in a required standard or custom Salesforce table. | |
| Metadata - Get Creatable Objects | Retrieves a list of creatable objects in Salesforce. | |
| Metadata - Get Deletable Objects | Retrieves a list of deletable objects in Salesforce. | |
| Metadata - Get Updatable Fields | Retrieves a list of updatable fields in a required standard or custom Salesforce table. | |
| Metadata - Get Updatable Objects | Retrieves a list of updatable objects in Salesforce. | |
| Metadata - Get Account Fields | Retrieves a list of fields in the Salesforce Account object. | |
| Metadata - Get Case Origin Values | Retrieves a list of case origins in Salesforce. The value field of the case origin from the Salesforce response body is mapped to the name field in JSON output. | |
| Metadata - Get Case Priorities | Retrieves a list of case priorities in Salesforce. The value field of the case priority from the Salesforce response body is mapped to the name field in JSON output. | |
| Metadata - Get Case Reasons | Retrieves a list of case reasons in Salesforce. The value field of the case reason from the Salesforce response body is mapped to the name field in JSON output. | |
| Metadata - Get Case Status Values | Retrieves a list of case status values in Salesforce. The value field of the case status from the Salesforce response body is mapped to the name field in JSON output. | |
| Metadata - Get Industries for Accounts | Retrieves all the industries available for accounts in Salesforce. | |
| Metadata - Get Industries for Lead | Retrieves a list of industries in the Salesforce Lead object. The value field of the industry from the Salesforce response body is mapped to the name field in JSON output. | |
| Metadata - Get Lead Status | Retrieves a list of lead status values in Salesforce. The value field of the lead status from the Salesforce response body is mapped to the name field in JSON output. | |
| Metadata - Get Objects | Retrieves all the available object names in Salesforce. | |
| Metadata - Get Opportunity Stages | Retrieves a list of opportunity stages in Salesforce. The value field of the opportunity stage from the Salesforce response body is mapped to the name field in JSON output. | |
| Metadata - Get Opportunity Types | Retrieves a list of opportunity types in Salesforce. The value field of the opportunity type from the Salesforce response body is mapped to the name field in JSON output. | |
| Metadata - Get Order Status Values | Retrieves a list of order status values in Salesforce. The value field of the order status from the Salesforce response body is mapped to the name field in JSON output. | |
| Metadata - Get Organization Type | Retrieves the organization type of the Salesforce instance. To use this action, perform the steps outlined in the Create a Salesforce integration profile section in Integrating with Salesforce. | |
| Metadata - Get Record Fields | Retrieves all the record fields for the specified table name. | |
| Metadata - Get Relationship Fields | Retrieves all the relationship fields for the specified object name. | |
| Metadata - Get Relationship Names | Retrieves all the relationship names for the specified object name. | |
| Metadata - Get User Email Encodings | Retrieves a list of email encodings in the Salesforce User object. The value field of the email encoding from the Salesforce response body is mapped to the name field in JSON output. | |
| Metadata - Get User Languages | Retrieves a list of languages in the Salesforce User object. The value field of the user language from the Salesforce response body is mapped to the name field in JSON output. | |
| Metadata - Get User Locales | Retrieves a list of locales in the Salesforce User object. The value field of the user locale from the Salesforce response body is mapped to the name field in JSON output. | |
| Metadata - Get User Time Zones | Retrieves list of time zones in the Salesforce User object. The value field of the time zone from the Salesforce response body is mapped to the name field in JSON output. | |
| Opportunity Management | Create Opportunity | Creates an opportunity in Salesforce. |
| Order Management | Create Order | Creates an order in Salesforce. |
| License Management | Look up User Licenses Stream | Retrieves user subscription information that is available in Salesforce. To use this action, perform the steps outlined in the Create a Salesforce CRM integration profile section in Integrating with Salesforce CRM. |
| Look up Usage Based Entitlements Stream | Retrieves the consumption usage details for the resources.To use this action, perform the steps outlined in the Create a Salesforce CRM integration profile section in Integrating with Salesforce CRM. | |
| User Management | Create User | Creates a user in Salesforce. |
| Look up User Profiles | Retrieves a list of user profiles in Salesforce. The name and ID fields of the user profiles from the Salesforce response body are mapped to the label and name fields respectively in the JSON output. | |
| Look up User Roles | Retrieves a list of user roles in Salesforce. The name and ID fields of the user profiles from the Salesforce response body are mapped to the label and name fields respectively in the JSON output. | |
| Look up Users | Retrieves user attributes for Salesforce users. To use this action, perform the steps outlined in the Create a Salesforce CRM integration profile section in Integrating with Salesforce CRM. | |
| Remove User | Reclaims a user account in Salesforce. To use this action, perform the steps outlined in the Create a Salesforce CRM integration profile section in Integrating with Salesforce CRM. |
Salesforce account requirements
The Salesforce spoke requires configuring your Salesforce account to generate an OAuth 2.0 JWT Bearer Grant token.
Connection and credential alias requirements
Integration Hub uses aliases to manage connection and credential information. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using multiple environments. If the connection or credential information changes, you don't need to update any actions that use the connection. For more information, see Connections and Credentials.
For information about setting up the spoke, see Set up the Salesforce spoke.
MID Server requirements
These actions use REST calls, which can run on an instance or MID Server. Use the connection record associated with the Salesforce alias to configure where actions run as well as set MID Server selection attributes. For more information, see MID server.
To set up the MID Server for this spoke, see Set up MID Server for a spoke.