Platform Event field reference
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 Event | API name in your org | One event represents | Publish behavior | Field reference |
|---|---|---|---|---|
| Record Health Check Set Run | rhc_ | The result counts for one record, or the end of an async job | Publish After Commit | Set Run fields |
| Record Health Check Result | rhc_ | The result of one Check for one record | Publish After Commit | Result fields |
| Record Health Check Log | rhc_ | One technical error captured during a run | Publish Immediately | Log fields |
All three are high-volume Platform Events. Salesforce keeps them for 72 hours.
Field names in your org
Section titled “Field names in your org”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 field | Example |
|---|---|
| Apex trigger or class | eventRecord. |
| Platform Event-triggered Flow | {!$Record. |
| Pub/Sub API event schema | rhc_ |
The package’s own source code uses the names without the prefix, such as EventId__c.
Fields on every event
Section titled “Fields on every event”| Field | API name in your org | Type | Value |
|---|---|---|---|
| Event ID | rhc_ | Text(80), required | A different value for every event. Save it in a Unique field to detect a repeated event. |
| Run ID | rhc_ | Text(120), required | The same value for every event from one run or job. Not unique. |
| Occurred At | rhc_ | Date/Time, required | When Record Health Check created the event. |
| Contract Version | rhc_ | Text(10), required | 1., the version of the event’s fields. It changes only when a field changes incompatibly. |
| Framework Version | rhc_ | Text(20) | The Record Health Check release that published the event, 2. 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.
What the events never contain
Section titled “What the events never contain”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.