salesforce

type: meya.salesforce.integration
class: SalesforceIntegration
path: /meya/salesforce/integration/integration.py
signature: -

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. [email protected]).
  • Get the user's password used to login on Salesforce.
  • Past the username and password 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 and Consumer Secret and paste to client_id and client_secret vault variables, respectively.

Fields

field

signature

required

type

default

description               

instance_base_url

str

Your Salesforce instance's base URL with no trailing /, e.g. https://your-instance.salesforce.com

client_id

str

This field is called Consumer Key in the Salesforce Admin console and client_id in the Auth Api request.The Consumer Key can be found at Salesforce > Build > Create > Apps > Your app.

client_secret

str

This field is called Consumer Secret in the Salesforce Admin console and client_secret in the Auth Api request.The Consumer Secret can be found at Salesforce > Build > Create > Apps > Your app.

username

str

The email of a valid user in your Salesforce instance. Usually you would create a dedicated user for app integrations.

password

str

The password of the user you use to login to your Salesforce instance.

spec

ForwardRef('Spec')

null

Override the original spec for this element

enabled

bool

true

Enables the integration, allowing it to process events and HTTP entries

filter

IntegrationFilter

rx_sub: true
rx: true
tx: true
tx_pub: true

verify_token

str

null

max_attachment_size

int

null

Controls maximum attachment size supported by the integration in bytes

Examples

Basic

type: meya.salesforce.integration
instance_base_url: STRING
client_id: STRING
client_secret: STRING
username: STRING
password: STRING

Full

type: meya.salesforce.integration
instance_base_url: STRING
client_id: STRING
client_secret: STRING
username: STRING
password: STRING
spec: '?'
enabled: false
filter:
  rx_sub: STRING
  rx: STRING
  tx: STRING
  tx_pub: STRING
verify_token: STRING
max_attachment_size: 123