Describe Object
salesforce.describe_object
ActionCRM & salesconnection required
Calls the Salesforce REST API at the connection's instance URL.
Describe one sObject: its metadata and every field an author can write.
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
1 field, 1 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 to describe, e.g. Opportunity. Supports {{ }}. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
name API name, e.g. Account. | string | — |
label Display label. | string | — |
label_plural Plural display label. | string | — |
key_prefix The three characters every id of this type starts with. | string | — |
custom True for a custom object. | boolean | — |
createable True when the user may create records. | boolean | — |
updateable True when the user may update records. | boolean | — |
deletable True when the user may delete records. | boolean | — |
queryable True when the object may appear in a SOQL FROM clause. | boolean | — |
fields One entry per field on the object. | array | — |
fields[].name API field name. | string | — |
fields[].label Display label. | string | — |
fields[].type Salesforce field type, e.g. picklist. | string | — |
fields[].length Maximum length for text fields. | number | — |
fields[].custom True for a custom field. | boolean | — |
fields[].nillable True when the field accepts null. | boolean | — |
fields[].createable True when the field can be set on create. | boolean | — |
fields[].updateable True when the field can be updated. | boolean | — |
fields[].external_id True when the field is an external id. | boolean | — |
fields[].unique True when values must be unique. | boolean | — |
fields[].reference_to sObjects a lookup/master-detail points at. | array | — |
fields[].picklist_values Allowed values for a picklist field. | array | — |
field_count How many fields were described. | number | — |
{
"createable": false,
"custom": false,
"deletable": false,
"field_count": 0,
"fields": [
{
"createable": false,
"custom": false,
"external_id": false,
"label": "",
"length": 0,
"name": "",
"nillable": false,
"picklist_values": [],
"reference_to": [],
"type": "",
"unique": false,
"updateable": false
}
],
"key_prefix": "",
"label": "",
"label_plural": "",
"name": "",
"queryable": false,
"updateable": false
}Notes
- A raw describe runs to hundreds of kilobytes, so each field is reduced to the keys above rather than returned whole.
Templates that use Salesforce
Solutions with Salesforce
See Describe Object 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.