Platform Events Developer Guide

Platform Events Developer Guide
Delivering Custom Notifications with Platform Events
Defining Your Custom Platform Event
Publishing Platform Events
Subscribing to Platform Events
Testing Your Platform Event in Apex
Encrypting Platform Event Messages at Rest in the Event Bus
Monitor Platform Event Publishing and Delivery Usage
Considerations
Examples
Reference
Platform Event Allocations
EventBusSubscriber
EventBus Class
Platform Event Error Status Codes
TriggerContext Class
Standard Platform Event Objects
Change Data Capture Events
Standard Platform Event Object List
AIPredictionEvent
AIUpdateRecordEvent
AppointmentSchedulingEvent
AssetCancelInitiatedEvent
AssetCancelErrorDtlEvent
AssetRenewInitiatedEvent
AssetTokenEvent
BatchApexErrorEvent
BillingScheduleCreatedEvent
CommerceDiagnosticEvent
ConsentEvent
CreateAssetOrderEvent
CreditInvoiceProcessedEvent
CreditMemoProcessedEvent
DataObjectDataChgEvent
DataObjectMetadataChgEvent
DatasetExportEvent
FlowExecutionErrorEvent
FlowOrchestrationEvent
FOStatusChangedEvent
FulfillOrdItemQtyChgEvent
InvoiceProcessedEvent
OrderStatusChangedEvent
OrderSummaryCreatedEvent
OrderSumStatusChangedEvent
PaymentCreationEvent
PlatformStatusAlertEvent
ProcessExceptionEvent
RealtimeAlertEvent
RemoteKeyCalloutEvent
VoidInvoiceProcessedEvent
Real-Time Event Monitoring Objects
PDF

Newer Version Available

This content describes an older version of this product. View Latest

AssetCancelInitiatedEvent

Notifies subscribers when the process started by the /asset-management/assets/collection/actions/initiate-cancellation request is complete. If the process is successful, use this event to learn about the cancellation order that was created. If the process isn't successful, use this event to learn about the errors and how to fix them. This object is available in API version 55.0 and later.

Supported Calls

describeSObjects()

Supported Subscribers

Subscriber Supported?
Apex Triggers Yes
Flows Yes
Processes Yes
Pub/Sub API Yes
Streaming API (CometD) Yes

Subscription Channel

/event/AssetCancelInitiatedEvent

Special Access Rules

This object is available when Subscription Management is enabled.

Fields

Field Details
AssetCancelErrorDetailEvents
Type
AssetCancelErrorDtlEvent[]
Properties
Nillable
Description
Contains a list of error messages and error codes if the request failed.
CancellationRecordId
Type
string
Properties
Nillable
Description
The ID of the cancellation order. If the process failed, this field is null.
CorrelationIdentifier
Type
string
Properties
Nillable
Description
Reserved for future use.
EventUuid
Type
string
Properties
Nillable
Description
A universally unique identifier (UUID) that identifies a platform event message.
HasErrors
Type
boolean
Properties
Defaulted on create
Description
Contains true if errors occurred during the process; otherwise false. The default value is false.
ReplayId
Type
string
Properties
Nillable
Description
Represents an ID value that is populated by the system and refers to the position of the event in the event stream. Replay ID values aren’t guaranteed to be contiguous for consecutive events. A subscriber can store a replay ID value and use it on resubscription to retrieve missed events that are within the retention window.
RequestIdentifier
Type
string
Properties
Nillable
Description
The unique ID returned in the /asset-management/assets/collection/actions/initiate-cancellation response. Use this ID to identify the event for a specific request.