Salesforce Automation Flow

A Salesforce Flow definition representing an automation built with Flow Builder. Flows are the primary declarative automation tool in Salesforce, replacing Workflow Rules and Process Builder. They support screen flows (user-interactive), autolaunched flows (triggered automatically), scheduled flows, record-triggered flows, and platform event-triggered flows. This schema models the Flow metadata as returned by the Tooling API and Metadata API.

AutomationCloudCRMEnterpriseSales

Properties

Name Type Description
Id string The 18-character Salesforce record ID for this specific Flow version. Each version of a Flow has a unique ID.
DefinitionId string The 18-character ID of the parent FlowDefinition record. All versions of the same flow share this DefinitionId.
DeveloperName string The unique developer name (API name) for this flow. Used as the identifier in metadata deployments and API references. Cannot contain spaces or special characters.
MasterLabel string The display label shown in the Flow Builder UI and flow list views.
Description stringnull An optional description of the flow's purpose and behavior.
ProcessType string The type of flow, which determines how and when it executes. AutoLaunchedFlow runs without user interaction (triggered by records, schedules, or invocable actions). Flow is a Screen Flow that presents
TriggerType stringnull For record-triggered flows, specifies when the flow runs relative to the DML operation.
TriggerObject stringnull For record-triggered flows, the API name of the SObject that triggers the flow (e.g., Account, Contact, Opportunity, CustomObject__c).
RecordTriggerType stringnull For record-triggered flows, specifies which record operations trigger the flow.
Status string The status of this flow version. Active means this version is the currently running version. Draft is a version under development. Obsolete is a previously active version that has been superseded. Inv
VersionNumber integer The version number within the FlowDefinition. Increments with each new version. The active version number is stored on the FlowDefinition record.
ApiVersion string The Salesforce API version this flow was created with (e.g., 63.0). Determines which flow features are available.
RunInMode stringnull The context in which the flow runs. SystemModeWithSharing runs with full object/field access but respects sharing rules. SystemModeWithoutSharing runs with full access and no sharing restrictions. Def
Metadata object The full flow metadata containing all elements, connectors, variables, and configuration. This is the complete definition of the flow's logic.
FullName string The fully qualified name including namespace prefix if applicable (e.g., MyNamespace__MyFlow-1)
IsTemplate boolean Whether this flow is a template that can be used to create new flows
IsOverridable boolean Whether this flow can be overridden by a flow in a subscriber org
CreatedDate string The date and time this flow version was created, in ISO 8601 format
CreatedById string The 18-character ID of the user who created this flow version
LastModifiedDate string The date and time this flow version was last modified
LastModifiedById string The 18-character ID of the user who last modified this flow version
View JSON Schema on GitHub