# ErrorEvent

Output payload returned for the error-event platform event type.

> Kind: Apex type · Updated: 2026-07-01

This custom Apex type represents the output that Platform Events and the Platform Events Apex Handler methods return for the error-event platform event type. Exactly one of the nested error fields is populated, depending on which operation raised the error.

## Fields

### Output fields
| Parameter | Type | Required | Description |
|---|---|---|---|
| ErrorEventType | String | optional | The type of error event that was raised. |
| ErrorReason | String | optional | A human-readable description of why the error occurred. |
| SalesforceFileCopiedError | <a href="#/apex-type-salesforce-file-copied-error">SalesforceFileCopiedError</a> | optional | Populated when a Salesforce file copy operation failed. See SalesforceFileCopiedError. |
| DocumentProcessedError | <a href="#/apex-type-document-processed-error">DocumentProcessedError</a> | optional | Populated when document processing failed. See DocumentProcessedError. |
| ResourceUpdateError | <a href="#/apex-type-resource-update-error">ResourceUpdateError</a> | optional | Populated when a resource update failed. See ResourceUpdateError. |
| DocumentMapperRunError | <a href="#/apex-type-document-mapper-run-error">DocumentMapperRunError</a> | optional | Populated when a document mapper run failed. See DocumentMapperRunError. |
| DatasetCreatedError | <a href="#/apex-type-dataset-created-error">DatasetCreatedError</a> | optional | Populated when dataset creation failed. See DatasetCreatedError. |
| ResourceMovedError | <a href="#/apex-type-resource-moved-error">ResourceMovedError</a> | optional | Populated when a resource move operation failed. See ResourceMovedError. |
| DocumentGeneratedError | <a href="#/apex-type-document-generated-error">DocumentGeneratedError</a> | optional | Populated when document generation failed. See DocumentGeneratedError. |
| SiteGroupMembersUpdatedError | <a href="#/apex-type-site-group-members-updated-error">SiteGroupMembersUpdatedError</a> | optional | Populated when a site group members update failed. See SiteGroupMembersUpdatedError. |