Salesforce Metadata icon

Salesforce Metadata

Interact with Salesforce metadata APIs
Join our community

Actions5

Overview

This node interacts with Salesforce metadata APIs to perform various metadata-related operations. Specifically, the 'Describe One Object' operation inspects a single Salesforce SObject using the REST API, providing detailed information about the object's fields and properties. This is useful for understanding the structure and capabilities of a specific Salesforce object, such as 'Account' or 'Contact'. Practical applications include dynamically adapting workflows based on object metadata or validating data structures before processing.

Use Case Examples

  1. Retrieve metadata details of the 'Account' object to understand its fields and properties.
  2. Use the metadata information to dynamically generate forms or validation rules in an automation workflow.

Properties

Name Meaning
Authentication Specifies the authentication method to connect to Salesforce, either OAuth2 or JWT Bearer.
API Version Sets the Salesforce API version to use, e.g., 'v59.0'. 'auto' detects the latest available version automatically.
SObject API Name The API name of the Salesforce object (SObject) to describe, e.g., 'Account'. This is required.
Raw Response If true, returns the raw Salesforce API response instead of a cleaned and simplified output.

Output

JSON

  • name - The API name of the described SObject.
  • label - The user-friendly label of the SObject.
  • custom - Boolean indicating if the SObject is a custom object.
  • fields - Array of field objects, each containing details such as name, label, type, updateable, createable, nillable, and length.
  • recordTypeInfos - Array of record type information objects for the SObject.

Dependencies

  • Requires Salesforce API access with OAuth2 or JWT Bearer authentication credentials.

Troubleshooting

  • Error if 'SObject API Name' is missing or empty: Ensure the API name of the SObject is provided.
  • Authentication failures: Verify that the OAuth2 or JWT credentials are correctly configured and valid.
  • API version issues: If using a specific API version, ensure it is supported by the Salesforce instance.
  • Network or permission errors: Confirm that the Salesforce user has permission to access metadata and the network connection is stable.

Links

Discussion