Payload reference
Consolidated reference for RCM webhook bodies. The envelope and the validation and audit payloads are snake_case with null fields omitted. The classification payload is the exception: its keys are camelCase and null fields are kept — see Classification.
Envelope
Every webhook body wraps an event-specific payload:
| Field | Type | Description |
|---|---|---|
event_id | string (UUID) | Mirrors X-RCM-Event-ID. Idempotency key. |
event_type | string | Mirrors X-RCM-Event-Type. |
entity_type | string | support_file (validation), support_document (classification) or charge_audit_item (RGA audit). |
entity_id | string (UUID) | ID of the related domain entity. |
payload | object | Event-specific payload (below). |
metadata | object | System metadata; may be {}. |
created_at | string (ISO-8601) | When the event was created. |
event_id vs idPush webhook deliveries name the event id event_id (mirroring X-RCM-Event-ID). Events read through the pull API — which is how RGA audit events are consumed — name the same field id. The rest of the envelope is identical.
Event types
event_type | entity_type | Payload |
|---|---|---|
DOCUMENT_CLASSIFICATION_COMPLETED | support_document | Classification |
DOCUMENT_CLASSIFICATION_FAILED | support_document | Classification |
DOCUMENT_VALIDATION_COMPLETED | support_file | Validation |
DOCUMENT_VALIDATION_REJECTED | support_file | Validation |
CHARGE_AUDIT_ACCEPTED | charge_audit_item | Audit events |
CHARGE_AUDIT_UPDATED | charge_audit_item | Audit events |
CHARGE_AUDIT_DELETED | charge_audit_item | Audit events |
CHARGE_AUDIT_PENDING | charge_audit_item | Audit events |
The table above covers the events with a stable payload. Account, charge, invoice and settlement-batch events (ACCOUNT_*, CHARGE_*, INVOICE_*, INVOICE_ASSIGNMENT_*, INVOICE_CHARGE_ASSIGNMENT_*, SETTLEMENT_GROUP_*, AUTOMATIC_SETTLEMENT_DELIVERY_ENABLED) are emitted in preview and listed with their key fields in the Event catalog.
Validation payload
See Validation events → Field reference for the full table. Key fields: document_id, support_file_code, document_level (ACCOUNT/CHARGE), account_id, charge_id, provider_slug, origin_event_id, validation_status (APPROVED/REJECTED), precision_percentage, analysis_type_applied, document_type_code, errors[], validated_at.
Each errors[] entry: field, value, reason, subreason, reason_key, precision_percentage.
Classification payload
See Classification events for the full tables.
- COMPLETED:
documentId,supportFileCode,dvsDocumentType,originEventId,chargeCode,agreementCode,invoiceNumber,fileName,classifiedAt,associatedAt. - FAILED:
documentId,originEventId,agreementCode,fileName,failedAt,errorCode,errorReason,attempts.
Classification payload keys are camelCase, unlike the envelope.
Audit payload (RGA)
See Audit events → Field reference for the full table. All four CHARGE_AUDIT_* events share the same flat payload of 18 fields: correlation_id, sequence, provider_guide_number, procedure_code, procedure_description, execution_date, item_status (QUESTIONED/JUSTIFIED/APPROVED), notes, denial_number, submitted_quantity, submitted_value, adjusted_quantity, adjusted_value, agreed_quantity, agreed_value, ans_registry, audit_classification (ACCEPTED/UPDATED/DELETED/PENDING), cbos_description.
metadata carries source (always orizon-rga), rga_report_id and s3_url.
Dedupe on (correlation_id, sequence). item_status is the auditor's raw decision; audit_classification is the derived business action — see the mapping table.