Add Salesforce Connector

Audience: Low-code Engineers

Skill Prerequisites: Actions, Tokens, Connectors

Creates a new Salesforce connector in a connector group. The connector stores the Salesforce login details that the Salesforce actions use to sign in. The action can save the ID of the new connector in a token, so later actions can use or update it.

Plant an App signs in to Salesforce with the username, password and security token you store here. The password and security token are saved encrypted.

note

This action requires the Salesforce feature to be licensed.

Typical Use Cases

• Let each customer or department save its own Salesforce account from a form
• Create Salesforce connectors from a setup workflow instead of by hand
• Save the new connector's ID so you can test it or update it later

Don't use it to

• Change an existing Salesforce connector. Use Update Salesforce Connector instead.
• Check that the login details work. The action saves them without contacting Salesforce. Use Test Connector after saving.
• Add a connector of another type. Use Add Connector instead.

Related Actions

Action Name	Description
Update Salesforce Connector	Changes the details of an existing Salesforce connector.
Find Group	Gets a group ID from a group title and portal.
Test Connector	Checks that a connector can sign in.
Get Connector	Reads the details of a connector.
Delete Connector	Removes a connector.
Create a Salesforce Entity	Creates a record in Salesforce using a connector.
Run SOQL Query	Runs a SOQL query in Salesforce using a connector.
Add to Campaign	Adds a lead or contact to Salesforce campaigns using a connector.

Input Parameter Reference

Parameter	Description	Supports Tokens	Default	Required
Portal	The portal of the connector group. Leave it empty for global groups (not bound to a portal). It's only used to pick the group in the editor. When using an expression, the value must be the PortalId.	Yes	empty string	No
Group Title	The Salesforce connector group to add the connector to. The list shows Salesforce groups only. When using an expression, the value must be the GroupId. Use Find Group to get a GroupId from a group title and portal.	Yes	empty string	Yes
User Id	A user ID for the connector. In 1.28 this value isn't saved on the connector.	Yes	empty string	No
Entry title	The name of the connector, for example Salesforce - [CompanyName].	Yes	empty string	No
Login Url	The Salesforce login domain, for example https://ap1.salesforce.com/. If the value doesn't end with /services/oauth2/token, that path is added. Leave it empty to use https://login.salesforce.com/services/oauth2/token.	Yes	empty string	No
Account Username	The Salesforce username.	Yes	empty string	Yes
Password	The Salesforce password. Saved encrypted.	Yes	empty string	Yes
Security Token	The Salesforce security token for the user. Saved encrypted.	Yes	empty string	Yes
Custom Data	Extra name-value pairs to store on the connector, entered as Data Key and Data Value. Keys must be unique and can't repeat the names of the other fields.	Yes	empty	No
EntryId Token Name	The name of a token to save the new connector's ID in, for example SalesforceConnectorId. Brackets are optional.	No	empty string	No

Output Parameters Reference

Parameter	Description
[<EntryId Token Name>]	The ID of the new connector, a GUID. It's only set when EntryId Token Name has a value.

Considerations

• The group decides the connector type. Pick a Salesforce group. If Group Title is empty or isn't a number, the action fails with Invalid GroupId. If no group has that ID, it fails with Connector group (id: ...) not found.
• Username, password and security token are required. If one is empty, the action fails with Parameter '<field title>' is required. and nothing is saved.
• The login isn't tested. A wrong password or token is saved without an error. Run Test Connector to check it.
• Sandbox orgs use a different login domain. Put the sandbox domain, for example https://test.salesforce.com, in Login Url.
• Keep secrets out of the action. Pass the password and security token through tokens, for example from a form, instead of typing them into the action.

Examples

tip

To understand how to use the below examples, please see Running Examples.

1. Save a customer's Salesforce account

This action adds a connector to the Salesforce group with ID [SalesforceGroupId], using values from a form. The new connector's ID is saved in [SalesforceConnectorId].

{
    "Title": "Add Salesforce Connector",
    "ActionType": "cs.salesforce",
    "Description": "Save the customer's Salesforce login",
    "Parameters": {
        "Group": "[SalesforceGroupId]",
        "EntryName": "Salesforce - [CompanyName]",
        "LoginUrl": "",
        "UserName": "[SalesforceUsername]",
        "Password": "[SalesforcePassword]",
        "SecurityToken": "[SalesforceSecurityToken]",
        "EntryIdTokenName": "SalesforceConnectorId"
    }
}

Revised 09/26/2026