A component enables you to manage your organization’s sales, marketing and customer support assets, far beyond email addresses and phone numbers.
Please Note: The component works with the Salesforce API. This means you must make sure your Salesforce edition has API Access enabled. To check which editions have API access see the Salesforce editions with API Access document. If your edition has no API Access by default this component will not work for you..
The component uses Salesforce - API Version 46.0 by defaults but can be overwritten by the environment variable SALESFORCE_API_VERSION
.
Please note: Deprecated Actions and Triggers - API Version 25.0.
Name | Mandatory | Description | Values |
---|---|---|---|
SALESFORCE_API_VERSION | false | Determines API version of Salesforce to use | Default: 46.0 |
REFRESH_TOKEN_RETRIES | false | Determines how many retries to refresh token should be done before throwing an error | Default: 10 |
HASH_LIMIT_TIME | false | Hash expiration time in ms | Default: 600000 |
HASH_LIMIT_ELEMENTS | false | Hash size number limit | Default: 10 |
UPSERT_TIME_OUT | false | Time out for Upsert Object action in ms |
Default: 120000 (2min) |
Please Note: From the platform version 20.51 we deprecated the component
LOG_LEVEL
environment variable. Now you can control logging level per each step of the flow.
The technical notes page gives some technical details about Salesforce component like changelog and the completeness matrix.
Authentication occurs via OAuth 2.0.
In order to make OAuth work, you need a new App in your Salesforce. During app creation process you will be asked to specify the callback URL, to process OAuth authentication via elastic.io platform your callback URL should be /callback/oauth2
.
More information you can find here.
Please note: Salesforce migration or any changes that affect endpoints, single sign-on (SSO), OAuth and JSON web tokens (JWT), and other connections can lead to unpredictable behavior that can cause authentication issues. To avoid this after making changes you need to create new credentials and authenticate again, once this is done the old ones can be safely removed from the platform.
Warning: To maintain a smooth experience, we recommend reusing stored credentials where possible. Duplicating secrets across OAuth clients can result in errors and complications.
During credentials creation you would need to:
Choose Auth Client
or create the new one.For creating Auth Client you should specify following fields:
Field name | Mandatory | Description |
---|---|---|
Name | true | your Auth Client’s name |
Client ID | true | your OAuth client key |
Client Secret | true | your OAuth client secret |
Authorization Endpoint | true | your OAuth authorization endpoint. For production use https://login.salesforce.com/services/oauth2/authorize , for sandbox - https://test.salesforce.com/services/oauth2/authorize |
Token Endpoint | true | your OAuth Token endpoint for refreshing access token. For production use https://login.salesforce.com/services/oauth2/token , for sandbox - https://test.salesforce.com/services/oauth2/token |
Name Your Credential
.Authenticate
button - if you have not logged in Salesforce before then log in by entering data in the login window that appears.Verify
button for verifying your credentials.Save
button for saving your credentials.Here you can see how to select an existing client
:
For more information pleas read our Creating OAuth App for Salesforce article.
Please Note: When you deploy the Salesforce component separately into a dedicated tenant or into your developer team it can not use the OAuth App specifically created for our main AVA tenant. For this purposes you must create a different OAuth App and add the required environment variables to the component setup.
Salesforce component includes the following triggers:
SOQL
query and emits results one-by-one. Use the Salesforce Object Query Language (SOQL
) to search your organization’s Salesforce data for specific information.You can find information on deprecated triggers here.
Use this list to navigate to the action you seek.
SOQL
query that may return many objects. Each resulting object is emitted one-by-one. Use the Salesforce Object Query Language (SOQL
) to search your organization’s Salesforce data for specific information.You can find information on deprecated actions here.
By default, certain user profiles in Salesforce have disabled permissions. In order to ensure the visibility of an object in the metadata of component’s actions and triggers, it is necessary to enable the required standard object permissions.
To enable these permissions, please follow these steps:
Once you are on the profile editing page, ensure that all the required standard object permissions are enabled. For instance, if you intend to utilize the Get New and Updated Objects Polling trigger, the following permissions are necessary: Read, Create, and Edit.
Carefully review the permissions and make any necessary adjustments to enable the required access.
Attachments mechanism doesn’t work with Local Agent Installation.