Reference

Salesforce

Salesforce.com is a cloud-based customer relationship management (CRM) software used to manage customer data, sales processes, marketing campaigns, and customer service activities

Salesforce.com is a cloud-based customer relationship management (CRM) software used to manage customer data, sales processes, marketing campaigns, and customer service activities

Category: Customer Support. Adds 3 actions to a care flow.

What to configure

Set these once, on the extension in Awell Studio. An action fails at run time if a required setting is missing.

SettingRequiredNotes
API versionNoDefaults to v61.0
Client IDYes
Client secretYes— Stored as a secret.
PasswordNoThe password of the user that the connected app is imitating. A password is only needed when using the Password grant, leave blank to use client credentials grant Stored as a secret.
Domain nameYesThe subdomain of your Salesforce tenant (e.g. "awell" or "awell.sandbox")
UsernameNoThe username of the user that the connected app is imitating. A username is only needed when using the Password grant, leave blank to use client credentials grant.

Actions

Salesforce adds these 3 actions to a care flow. Add one to a step, then fill in its inputs.

Create lead

Creates a new lead object in Salesforce

InputTypeRequiredDescription
DatajsonYesInformation used to create the Lead
Care Flow ID FieldstringNoThe field name in Salesforce that contains the Care Flow ID. If left blank, the Care Flow ID will not be included in the update.

Returns:

Data pointType
createdLeadIdstring

Get lead

Retrieve a Lead from Salesforce

This action can be previewed in Studio before you publish.

InputTypeRequiredDescription
Lead IDstringYes

Returns:

Data pointType
leadDatajson

Update lead

Updates an existing lead object in Salesforce

This action can be previewed in Studio before you publish, and retries automatically on a transient failure.

InputTypeRequiredDescription
Lead IDstringYesThe object ID of the Lead in Salesforce to update
DatajsonYesInformation used to update the Lead

Setup and notes

Salesforce

SFDC is a cloud-based customer relationship management (CRM) software used to manage customer data, sales processes, marketing campaigns, and customer service activities

Extension settings

For this extension to work, you will need to provide the below settings:

  • Salesforce subdomain (https://<SUBDOMAIN>.my.salesforce.com/services/oauth2/token)
  • Client ID
  • Client secret
  • Username*
  • Password*

Username and password are optional. When specified, the Password grant will be used to authenticate with the Salesforce API. When left blank, the Client Credentials grant will be used.

Create a Lead

A lead is a standard Salesforce object (sObject). You can use this action to create a Lead object.

Update a lead

Updates a Lead record based on the specified data and provided Lead record ID. Field values provided replace the existing values in the Lead record (PATCH).

Changelog

Salesforce changelog

Where this page comes from

The settings, actions, inputs, outputs and webhooks above are generated from the extension's own code, at @awell-health/awell-extensions v2.1.159. They match what the platform actually does rather than a description of it.

Field-level detail also appears in Awell Studio when you configure the action. Something wrong or missing? Email support@awellhealth.com.

On this page