Actions5
Overview
This node interacts with Salesforce to retrieve metadata information about Salesforce objects (SObjects) and other metadata components. Specifically, the 'Describe One SObject' operation fetches detailed information about a single Salesforce object, including its fields and record type information. This is useful for users who need to understand the structure and properties of a specific Salesforce object, such as when integrating Salesforce data into other systems or automating workflows that depend on Salesforce metadata.
Use Case Examples
- A user wants to get detailed field information for the 'Account' object to dynamically generate forms or reports.
- A developer needs to inspect the record types and field properties of a custom Salesforce object to build an integration that respects Salesforce data constraints.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method used to authenticate with Salesforce API, either OAuth2 or JWT Bearer. |
| API Version | Salesforce API version to use for the request, e.g., 'v60.0' or 'auto' for the latest version. |
| SObject API Name | The API name of the Salesforce object to describe, e.g., 'Account'. |
| Raw Response | If true, returns the raw Salesforce API response for inspection, otherwise returns a sanitized and structured output. |
Output
JSON
name- API name of the Salesforce object.label- Label of the Salesforce object.custom- Boolean indicating if the object is custom.fields- Array of fields on the object, each with properties like name, label, type, updateable, createable, nillable, and length.recordTypeInfos- Array of record type information for the object.
Dependencies
- Salesforce API connection using OAuth2 or JWT authentication
Troubleshooting
- If the 'SObject API Name' is missing or incorrect, the node will throw an error indicating the requirement of this parameter.
- Authentication failures can occur if the OAuth2 or JWT credentials are invalid or expired; ensure valid credentials are configured.
- API version mismatches might cause unexpected errors; use 'auto' to default to the latest supported version or specify a valid version string.
- If the Salesforce API returns an error, the node will either throw an error or return an error object if 'Continue On Fail' is enabled.