Skip to content
Suggest a correction

Platform Event field reference

Reference2 min read

Look up the fields, types, and values of the three Platform Events that Record Health Check publishes. A Platform Event-triggered Flow, an Apex trigger, or an external Pub/Sub API subscriber reads these fields to save or route results after a run.

Platform EventAPI name in your orgOne event representsPublish behaviorField reference
Record Health Check Set Runrhc__Record_Health_Check_Set_Run__eThe result counts for one record, or the end of an async jobPublish After CommitSet Run fields
Record Health Check Resultrhc__Record_Health_Check_Result__eThe result of one Check for one recordPublish After CommitResult fields
Record Health Check Logrhc__Record_Health_Check_Log__eOne technical error captured during a runPublish ImmediatelyLog fields

All three are high-volume Platform Events. Salesforce keeps them for 72 hours.

The events install with the Record Health Check package, whose namespace prefix is rhc. In your org, every event and every field name starts with rhc__:

Where you use the fieldExample
Apex trigger or classeventRecord.rhc__EventId__c
Platform Event-triggered Flow{!$Record.rhc__EventId__c}
Pub/Sub API event schemarhc__EventId__c

The package’s own source code uses the names without the prefix, such as EventId__c.

FieldAPI name in your orgTypeValue
Event IDrhc__EventId__cText(80), requiredA different value for every event. Save it in a Unique field to detect a repeated event.
Run IDrhc__RunId__cText(120), requiredThe same value for every event from one run or job. Not unique.
Occurred Atrhc__OccurredAt__cDate/Time, requiredWhen Record Health Check created the event.
Contract Versionrhc__ContractVersion__cText(10), required1.0, the version of the event’s fields. It changes only when a field changes incompatibly.
Framework Versionrhc__FrameworkVersion__cText(20)The Record Health Check release that published the event, 2.0.11 in this release.

Treat Event ID and Run ID as text. Their format can change, so never parse them.

Record Health Check can add fields to contract version 1.0. Receiving automation should ignore fields it does not recognize and send an unexpected Contract Version to review.

The Set Run and Result events never contain messages, Found or Expected values, formulas, queries, field values from the record, or the running user’s ID. The Log event can contain the running user’s ID, error messages, and stack traces, so restrict who can receive it.