Flow action inputs and outputs
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.
Run Record Health Check Set
Section titled “Run Record Health Check Set”Runs every active Check in one Check Set for each input record. Apex class:
RecordHealthCheckRunSetFlowAction.
Inputs
Section titled “Inputs”| Input | Required | Value |
|---|---|---|
| Check Set Qualified API Name | Yes | The Check Set’s API name, such as Account_, or rhc_ for an installed example. |
| Record ID | Yes | The record to evaluate. It must be a record of the Check Set’s object. |
| Event Publication | Yes | NONE, ACTIONABLE, or ALL. Capitalization and surrounding spaces are ignored. See Event Publication. |
Outputs
Section titled “Outputs”| Output | Type | Value |
|---|---|---|
| Success | Boolean | true when the input produced a result. When false, only Error Type and Error Message are set. |
| Error Type | Text | AUTHORIZATION, VALIDATION, LIMIT, or EXECUTION when Success is false. |
| Error Message | Text | A description of the problem when Success is false. |
| Status | Text | The most serious result among the Checks: ERROR, then UNABLE_, then FAIL, then PASS, then SKIPPED. |
| Passed Count | Number | Checks that returned PASS. |
| Failed Count | Number | Checks that returned FAIL, whatever their severity. |
| Skipped Count | Number | Checks that returned SKIPPED. |
| Unable Count | Number | Checks that returned UNABLE_. |
| System Error Count | Number | Checks that returned ERROR. |
| Result JSON | Text | The complete result for this record, as a serialized RecordHealthCheckResponse. |
| Contract Version | Text | The version of the output format, currently 2.. |
Run Record Health Check
Section titled “Run Record Health Check”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.
Inputs
Section titled “Inputs”| Input | Required | Value |
|---|---|---|
| Check Qualified API Name | Yes | The Check’s API name, such as Billing_, or rhc_ for an installed example. |
| Record ID | Yes | The record to evaluate. |
| Event Publication | Yes | NONE, ACTIONABLE, or ALL. |
Outputs
Section titled “Outputs”| Output | Type | Value |
|---|---|---|
| Success | Boolean | true when the input produced a result. |
| Error Type | Text | AUTHORIZATION, VALIDATION, LIMIT, or EXECUTION when Success is false. |
| Error Message | Text | A description of the problem when Success is false. |
| Status | Text | PASS, FAIL, SKIPPED, UNABLE_, or ERROR. |
| Reason Code | Text | A stable code that explains the result, such as INVALID_. See Reason codes. |
| Result JSON | Text | The complete result for this record, as a serialized RecordHealthCheckResultItem. |
| Contract Version | Text | The version of the output format, currently 2.. |
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.
| Output | Type | Value |
|---|---|---|
| Configuration Is Valid | Boolean | true when there are no errors. |
| Error Count | Number | Problems that make configuration invalid. |
| Warning Count | Number | Settings that are valid but probably not intended. |
| Validation Report JSON | Text | A 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.
Error types
Section titled “Error types”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 Type | Cause |
|---|---|
AUTHORIZATION | The running user does not have the Record Health Check Run Custom Permission, which Record Health Check User includes. |
VALIDATION | A 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. |
LIMIT | The 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. |
EXECUTION | The 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.
Limits
Section titled “Limits”| Limit | Value | What happens when exceeded |
|---|---|---|
| Groups per action call, where a group is one Check or Check Set with one Event Publication value | 10 | Every input returns Error Type LIMIT. |
| Records per group | 200 | The group’s inputs return Error Type VALIDATION. |
| Active Checks in a Check Set | 25 | The group’s inputs return Error Type LIMIT; no Check runs. |
| Result JSON per action call | 2,000,000 characters | The remaining inputs return Error Type LIMIT. |
| Formula evaluations per group | 95 | The group’s inputs return Error Type EXECUTION; no Check runs. |
| Remaining queries, query rows, DML statements, or heap in the transaction | Salesforce limits | The 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.
Event Publication
Section titled “Event Publication”| Value | Platform Events published after the transaction commits |
|---|---|
NONE | None. |
ACTIONABLE | A Record Health Check Result event for each FAIL, UNABLE_, or ERROR result, and one Record Health Check Set Run event per record. |
ALL | A 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.
Access
Section titled “Access”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.
Output versions
Section titled “Output versions”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.