Get Record by External Id
salesforce.get_record_by_external_id
ActionCRM & salesconnection required
Calls the Salesforce REST API at the connection's instance URL.
Read one sObject record by the value of an external-id field.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Salesforce
- Secret shape
- {"client_id", "client_secret", "refresh_token"}
- Config it needs
- login_url, api_version
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 fields, 3 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
sobject sObject type, e.g. Contact. Supports {{ }}. | string | Yes | — | — | — |
external_id_field API name of the external-id field to match on, e.g. External_Id__c. | string | Yes | — | — | — |
external_id_value The external-id value to look up. Supports {{ }}. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The record's Salesforce id. | string | — |
record The record as Salesforce returned it. | object | — |
{
"id": "",
"record": {}
}Notes
- Salesforce answers 404 when no record carries that external id.
- This resource takes no field list — the whole readable record comes back. Use salesforce.query to choose columns.
Templates that use Salesforce
Solutions with Salesforce
See Get Record by External Id run in a workflow.
In a technical demo we add the Salesforce connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.