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 'List Metadata Components' operation fetches metadata components of specified types from a Salesforce org, optionally filtered by folders and API version. This is useful for users who need to retrieve detailed metadata information for automation, integration, or analysis purposes, such as listing all custom objects, Apex classes, or reports in an org.

Use Case Examples

  1. A Salesforce admin wants to list all CustomObject and ApexClass metadata components to audit the org's customization.
  2. A developer needs to fetch all reports and dashboards metadata components stored in specific folders for backup or migration.

Properties

Name Meaning
Authentication Method used to authenticate with Salesforce (OAuth2 or JWT Bearer).
API Version Salesforce API version to use for the request, e.g., v59.0 or 'auto' to detect the latest version.
Metadata Types List of metadata component types to fetch from the Metadata API, e.g., CustomObject, ApexClass, Report.
Folders Folder API names used to filter folder-based metadata types like Report, Dashboard, EmailTemplate, and Document.
As Of Version Optional Metadata API version number to use for the list call.
Raw Response If true, returns the raw Salesforce API response instead of a cleaned and simplified output.

Output

JSON

  • json
    • type - Type of the metadata component.
    • fullName - Full API name of the metadata component.
    • fileName - File name of the metadata component, if available.
    • namespacePrefix - Namespace prefix of the component, if applicable.
    • manageableState - Manageable state of the component, if applicable.
    • lastModifiedByName - Name of the user who last modified the component.
    • lastModifiedDate - Date when the component was last modified.
    • createdByName - Name of the user who created the component.
    • createdDate - Date when the component was created.
    • id - Unique identifier of the metadata component, if available.

Dependencies

  • Salesforce API connection via OAuth2 or JWT Bearer authentication

Troubleshooting

  • Ensure at least one metadata type is selected; otherwise, the node throws an error.
  • If the Salesforce API version is set incorrectly, the node may fail to fetch metadata; use 'auto' to detect the latest version automatically.
  • Authentication failures can occur if OAuth2 or JWT credentials are invalid or expired; verify credentials before running the node.
  • If the 'Raw Response' option is enabled, the output will be the raw API response, which may require additional parsing.
  • Errors from Salesforce API calls are caught and can be returned as error messages if 'Continue On Fail' is enabled.

Discussion