Skip to content
Suggest a correction

Record Health Check Set Run event fields

Reference4 min read

Look up every field of the Record Health Check Set Run Platform Event, which reports how many Checks passed, failed, were skipped, could not be evaluated, or had a system error for one record after a run. Async jobs also publish one Set Run event when the job ends.

PropertyValue
LabelRecord Health Check Set Run
API name in your orgrhc__Record_Health_Check_Set_Run__e
Event typeHigh Volume
Publish behaviorPublish After Commit
Contract Version1.0

To save these events in a history object with Flow or Apex, see Save Check Set run summaries.

The run starts fromA Set Run event publishes for each record when
A person selecting Run or Rerun on the cardPublish User Run Event is selected on the Check Set.
A Flow action, Apex code, or an async jobEvent Publication is ACTIONABLE or ALL. With ACTIONABLE, it publishes even when every Check passes.

A run of a single Check also publishes a Set Run event per record, naming the Check’s Check Set.

When a Queueable, Batch, or Scheduled job runs with ACTIONABLE or ALL, it also publishes one job event when the job ends. Page loads, browser refreshes, the automatic rerun after a save, Agentforce actions, the MCP service, and Preview never publish. See Decide when to use Platform Events for every rule.

Salesforce delivers the event only after the transaction that ran the Checks completes. When that transaction rolls back, the event is discarded.

Field labelAPI name in your orgTypeRecord eventJob event
Event IDrhc__EventId__cText(80), requiredA different value for every eventSame
Run IDrhc__RunId__cText(120), requiredThe run’s ID, shared by all its eventsbatch- or queue- followed by the job ID
Phaserhc__Phase__cText(30), requiredCOMPLETEDCOMPLETED when every record was processed; otherwise FAILED
Check Set Qualified API Namerhc__CheckSetQualifiedApiName__cText(80), requiredThe Check Set that ranSame
Record IDrhc__RecordId__cText(18)The record that was checkedBlank
Sourcerhc__Source__cText(30), requiredWhat started the runQUEUEABLE, BATCH, or SCHEDULED
Occurred Atrhc__OccurredAt__cDate/Time, requiredWhen the event was createdSame
Contract Versionrhc__ContractVersion__cText(10), required1.0Same
Framework Versionrhc__FrameworkVersion__cText(20), required2.0.11Same
Eligible Check Countrhc__EligibleCheckCount__cNumber(5, 0)Checks the run includedBlank
Evaluated Check Countrhc__EvaluatedCheckCount__cNumber(5, 0)Results for this record: the sum of the five counts belowBlank
Passed Countrhc__PassedCount__cNumber(5, 0)Results with status PASSBlank
Failed Countrhc__FailedCount__cNumber(5, 0)Results with status FAILBlank
Skipped Countrhc__SkippedCount__cNumber(5, 0)Results with status SKIPPEDBlank
Unable Countrhc__UnableCount__cNumber(5, 0)Results with status UNABLE_TO_EVALUATEBlank
System Error Countrhc__SystemErrorCount__cNumber(5, 0)Results with status ERRORBlank
Submitted Record Countrhc__SubmittedRecordCount__cNumber(7, 0)BlankRecords submitted to the job
Processed Record Countrhc__ProcessedRecordCount__cNumber(7, 0)BlankRecords the job processed

Source is one of USER_INITIATED (the card), FLOW, APEX_API, QUEUEABLE, BATCH, or SCHEDULED.

The event has no overall status field. To derive one, use the first that applies: ERROR when System Error Count is above 0, then UNABLE_TO_EVALUATE, FAIL, and PASS for their counts, and SKIPPED otherwise.

{
"rhc__EventId__c": "rhc-api-1791387000000-9f2c41d07a3b4c6e8d15f0a-1-4e8a0c2d9b7f41a3e6c5d8b0a1f29374",
"rhc__RunId__c": "rhc-api-1791387000000-9f2c41d07a3b4c6e8d15f0a2b7c94e31",
"rhc__Phase__c": "COMPLETED",
"rhc__CheckSetQualifiedApiName__c": "Account_Data_Quality",
"rhc__RecordId__c": "001000000000001AAA",
"rhc__Source__c": "FLOW",
"rhc__OccurredAt__c": "2026-10-07T15:30:00.000Z",
"rhc__ContractVersion__c": "1.0",
"rhc__FrameworkVersion__c": "2.0.11",
"rhc__EligibleCheckCount__c": 5,
"rhc__EvaluatedCheckCount__c": 5,
"rhc__PassedCount__c": 3,
"rhc__FailedCount__c": 1,
"rhc__SkippedCount__c": 1,
"rhc__UnableCount__c": 0,
"rhc__SystemErrorCount__c": 0
}

The IDs, time, and counts are examples. Account_Data_Quality is a Check Set created in the org, so it has no prefix; an installed example Check Set has one, such as rhc__Example_Account_Check_Builder_Guide.

The Record Health Check Card User, Record Health Check User, and Record Health Check Admin permission sets grant Create and Read access to this event. Receiving automation needs Read access, plus access to any object it writes to.

The event names a Salesforce record. Protect saved copies as you protect that record.