Skip to content
Suggest a correction

Flow action inputs and outputs

Guide7 min read

Look up every input, output, error type, and limit of the three Flow actions that install with Record Health Check: Run Record Health Check Set, Run Record Health Check, and Validate Record Health Check Configuration. For a step-by-step build, see Run a Check from Flow.

The two Run actions are in the Record Health Check category in Flow Builder. Validate Record Health Check Configuration has no category; find it by searching for its name.

Runs every active Check in one Check Set for each input record. Apex class: RecordHealthCheckRunSetFlowAction.

InputRequiredValue
Check Set Qualified API NameYesThe Check Set’s API name, such as Account_Data_Quality, or rhc__Example_Account_Check_Builder_Guide for an installed example.
Record IDYesThe record to evaluate. It must be a record of the Check Set’s object.
Event PublicationYesNONE, ACTIONABLE, or ALL. Capitalization and surrounding spaces are ignored. See Event Publication.
OutputTypeValue
SuccessBooleantrue when the input produced a result. When false, only Error Type and Error Message are set.
Error TypeTextAUTHORIZATION, VALIDATION, LIMIT, or EXECUTION when Success is false.
Error MessageTextA description of the problem when Success is false.
StatusTextThe most serious result among the Checks: ERROR, then UNABLE_TO_EVALUATE, then FAIL, then PASS, then SKIPPED.
Passed CountNumberChecks that returned PASS.
Failed CountNumberChecks that returned FAIL, whatever their severity.
Skipped CountNumberChecks that returned SKIPPED.
Unable CountNumberChecks that returned UNABLE_TO_EVALUATE.
System Error CountNumberChecks that returned ERROR.
Result JSONTextThe complete result for this record, as a serialized RecordHealthCheckResponse.
Contract VersionTextThe version of the output format, currently 2.0.

Runs one Check for each input record. Apex class: RecordHealthCheckRunCheckFlowAction. The Check runs without its Prerequisite Check; use the Check Set action when a prerequisite matters.

InputRequiredValue
Check Qualified API NameYesThe Check’s API name, such as Billing_City_Is_Populated, or rhc__Example_Website_URL_Valid for an installed example.
Record IDYesThe record to evaluate.
Event PublicationYesNONE, ACTIONABLE, or ALL.
OutputTypeValue
SuccessBooleantrue when the input produced a result.
Error TypeTextAUTHORIZATION, VALIDATION, LIMIT, or EXECUTION when Success is false.
Error MessageTextA description of the problem when Success is false.
StatusTextPASS, FAIL, SKIPPED, UNABLE_TO_EVALUATE, or ERROR.
Reason CodeTextA stable code that explains the result, such as INVALID_APEX_PARAMETERS. See Reason codes.
Result JSONTextThe complete result for this record, as a serialized RecordHealthCheckResultItem.
Contract VersionTextThe version of the output format, currently 2.0.

The Flow actions return evaluation data only. Result JSON contains the status, severity, reason code, and typed Found and Expected values; it never contains the card’s messages, links, or formatted values, whatever the running user’s access. Branch on Status, Reason Code, and the counts rather than parsing Result JSON.

Result JSON uses the field names of the Apex response types. From Run Record Health Check Set, it is one rhc.RecordHealthCheckResponse for the input record, with runId, recordIds, checkQualifiedApiNames, results, and summary. From Run Record Health Check, it is one rhc.RecordHealthCheckResultItem, whose evaluation holds status, severity, reasonCode, found, expected, and comparisonOperator. Read the response describes every field and how to read a typed found or expected value.

Validate Record Health Check Configuration

Section titled “Validate Record Health Check Configuration”

Checks every Check Set and Check in the org, active and inactive, for configuration errors. It reads only configuration. Apex class: RecordHealthCheckValidateMetadataAction. It has no inputs, and the running user needs Record Health Check Admin.

OutputTypeValue
Configuration Is ValidBooleantrue when there are no errors.
Error CountNumberProblems that make configuration invalid.
Warning CountNumberSettings that are valid but probably not intended.
Validation Report JSONTextA list of every finding with severity, componentName, fieldName, message, reasonCode, and, when known, offendingToken and formula position details.

Validate configuration before activation explains how to run it.

When Success is false, Error Type names the kind of problem. These are request problems, not health results, and the Flow interview continues normally.

Error TypeCause
AUTHORIZATIONThe running user does not have the Record Health Check Run Custom Permission, which Record Health Check User includes.
VALIDATIONA required input is blank; the API name is not an active Check or Check Set; Event Publication is not a valid value; a group has more than 200 records; or the transaction does not have enough queries, query rows, DML statements, or heap left for the group.
LIMITThe call has more than 10 groups; the Check Set has more than 25 active Checks; or the Result JSON of the call passed 2,000,000 characters.
EXECUTIONThe request could not be evaluated for another reason, such as exceeding the formula evaluation budget. The message does not include internal details.

A Salesforce error that stops the whole action, such as an exhausted governor limit, does not produce an output. It runs the action’s fault path.

LimitValueWhat happens when exceeded
Groups per action call, where a group is one Check or Check Set with one Event Publication value10Every input returns Error Type LIMIT.
Records per group200The group’s inputs return Error Type VALIDATION.
Active Checks in a Check Set25The group’s inputs return Error Type LIMIT; no Check runs.
Result JSON per action call2,000,000 charactersThe remaining inputs return Error Type LIMIT.
Formula evaluations per group95The group’s inputs return Error Type EXECUTION; no Check runs.
Remaining queries, query rows, DML statements, or heap in the transactionSalesforce limitsThe group’s inputs return Error Type VALIDATION; no Check runs.

Salesforce can send many inputs in one action call, such as when a data load updates many records that start the same Flow. Inputs that use the same Check Set and the same Event Publication value form one group. For example, 150 Account updates that run Account_Data_Quality with NONE are one group. Each group is evaluated in one request, so its Checks also share the transaction’s query, formula, and CPU limits. See Platform limitations.

ValuePlatform Events published after the transaction commits
NONENone.
ACTIONABLEA Record Health Check Result event for each FAIL, UNABLE_TO_EVALUATE, or ERROR result, and one Record Health Check Set Run event per record.
ALLA Record Health Check Result event for every result, and one Record Health Check Set Run event per record.

Events from Flow have Source set to FLOW. Use NONE when the Flow handles the result itself. The Check Set’s Publish User Run Event and the Check’s Publish User Result Event apply only to the record-page card; Flow ignores them. If the transaction rolls back after the action, the events are not delivered. See Decide when to use Platform Events.

The actions evaluate with the access of the user who started the Flow, even when the Flow runs in system context. A record or field that user cannot see is not counted, and an object or field the user cannot read produces UNABLE_TO_EVALUATE. The actions never grant additional access.

Contract Version describes the shape of the action outputs and Result JSON, and changes only when that shape changes. It is independent of the package version and of the version on Platform Events. New fields can appear in Result JSON without a version change, so a process that reads it should ignore fields it does not recognize.