Install instructions
Salesforce Access Token documentation:
https://developer.salesforce.com/docs/atlas.en-us.api_iot.meta/api_iot/qs_auth_access_token.htm
Salesforce user
- Create or select a Salesforce user to be used as the integration user.
- Get the user's username used to login to Salesforce (e.g. bot@meya.ai).
- Get the user's password used to login on Salesforce.
- Past the
username
andpassword
into the vault variables.
Create app
- From Salesforce classic, go to Setup > Build > Create > Apps > Connected App (section) > New.
- Grant the necessary permissions.
Get Api credentials
- On the recently created app go to
API (Enable OAuth Settings)
section. - Copy the
Consumer Key
andConsumer Secret
and paste toclient_id
andclient_secret
vault variables, respectively.
Element details
type: meya.salesforce.cases.integration
class: SalesforceCasesIntegration
path: /meya/salesforce/cases/integration/integration.py
signature: -
Fields
field | description
| required | signature | default | type |
---|---|---|---|---|---|
instance_base_url | Your Salesforce instance's base URL with no trailing | ◉ | ○ | str | |
client_id | This field is called | ◉ | ○ | str | |
client_secret | This field is called | ◉ | ○ | str | |
username | The email of a valid user in your Salesforce instance. Usually you would create a dedicated user for app integrations. | ◉ | ○ | str | |
password | The password of the user you use to login to your Salesforce instance. | ◉ | ○ | str | |
spec | Override the original spec for this element. | ○ | ○ | null | Spec |
enabled | Enables the integration, allowing it to process events and HTTP/WS entries. | ○ | ○ | true | bool |
filter | ○ | ○ | rx_sub: true | IntegrationFilter | |
verify_token | The token to be verified for each incoming request. You need to add the | ○ | ○ | null | str |
max_attachment_size | Controls maximum attachment size supported by the integration in bytes. | ○ | ○ | null | int |
markdown | The markdown features that are supported by this integration. Check the Markdown guide for more info. | ○ | ○ | false | list |
typing | When set to | ○ | ○ | true | bool |
avatar | ○ | ○ | crop: circle | CspIntegrationAvatar | |
agent_command_prefix | ○ | ○ | "/" | str | |
transcript | ○ | ○ | count: 25 | CspIntegrationTranscript | |
agent | ○ | ○ | name: | AgentSpec | |
Usage reference
Basic
type meya.salesforce.cases.integration
instance_base_url STRING
client_id STRING
client_secret STRING
username STRING
password STRING
Full
type meya.salesforce.cases.integration
instance_base_url STRING
client_id STRING
client_secret STRING
username STRING
password STRING
spec
type STRING
data
STRING ANY
timeout123
trigger_when ANY
enabledfalse
filter
rx_sub STRING
rx STRING
tx STRING
tx_pub STRING
verify_token STRING
max_attachment_size123
markdown
format|linkify|breaks|typographer
typingfalse
avatar
crop circle|square
agent_command_prefix STRING
transcript
count123
user_prefix STRING
bot_prefix STRING
agent_prefix STRING
note_prefix STRING
agent
name full|first|first_initial|first_last_initial|first_initial_last_initial
avatar
image STRING
crop circle|square
monogram full|first|first_initial|first_last_initial|first_initial_last_initial