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
Platform Event Error Status Codes
Standard Platform Event Objects
Change Data Capture Events
Standard Platform Event Object List
AcademicTermGpaCalcEvent
AcadRgstrApplnEvent
AcadRgstrEligCritRunEvent
AiJobRunStatusEvent
AIPredictionEvent
AIUpdateRecordEvent
AppointmentSchedulingEvent
AssetCancelInitiatedEvent
AssetAmendInitiatedEvent
AssetRenewInitiatedEvent
AssetTokenEvent
AppvlWorkItemNtfcnEvent
BatchApexErrorEvent
BillingScheduleCreatedEvent
BulkApi2JobEvent (Beta)
CallCoachConfigModifyEvent
CartToOrderCompletedEvent
CommerceDiagnosticEvent
ConsentEvent
ConsentUnsubscribeAllEvent
ConversationInsightEvent
CreateAssetOrderEvent
CreateAssetOrderDtlEvent
CreditInvoiceProcessedEvent
CreditMemoProcessedEvent
DataObjectDataChgEvent
DataObjectMetadataChgEvent
DatasetExportEvent
DiscoveryPredictionEvent
EmailCapturedMatchEvent
ExtlRecShrEvent
ExtlRecShrResultEvent
FirstBillPaymentSetupEvent
FlowDebugRefreshEvent
FlowExecutionErrorEvent
FlowOrchestrationEvent
FOStatusChangedEvent
FulfillOrdItemQtyChgEvent
InsPlcyEndrStatusEvent
InsPolicyRnwlQuoteStatusEvent
InsPolicyRnwlStatusEvent
InteropTopicSubcrEvent
InvoiceProcessedEvent
InvoiceProcPymtExclEvent
NegInvcLineProcessedEvent
OmniTrackingEvent
OrderStatusChangedEvent
OrderSummaryCreatedEvent
OrderSumStatusChangedEvent
PaymentCreationEvent
PendingOrdSumProcEvent
PlaceOrderCompletedEvent
PlatformStatusAlertEvent
ProcessExceptionEvent
QuoteSaveEvent
QuoteToOrderCompletedEvent
RealtimeAlertEvent
RemoteKeyCalloutEvent
SrcPredJobStatusChgEvent
SearchIndexJobStatusEvent
ServiceAppointmentEvent
VoidInvoiceProcessedEvent
WebCartAbandonedEvent
WebStoreUserCreatedEvent
Real-Time Event Monitoring Objects
PDF

CreateAssetOrderEvent

Notifies subscribers that the process started by the /actions/standard/createOrUpdateAssetFromOrder or /actions/standard/createOrUpdateAssetFromOrderItem request is complete. If the process is successful, use this event to learn about the new assets. If the request 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/CreateAssetOrderEvent

Event Delivery Allocation Enforced

No

Special Access Rules

This object is available if Subscription Management or Revenue Cloud is enabled in your org. Users must have Read access on this event to receive or view event notifications.

Fields

Field Details
AssetDetails
Type
CreateAssetOrderDtlEvent
Properties
Nillable
Description
A list of AssetDetail records created as a result of a successful request.
Each AssetDetail contains an order item ID, asset ID, and IsSuccess flag. If the request failed, the AssetDetail also contains an error code and error message.
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.
IsLastEvent
Type
boolean
Properties
Defaulted on create
Description
Indicates whether this event is the final event in the request (true) or not (false). If true, then there are no more events associated with the request. This field is populated only in the final event in the request.
The default value is false.
This field is available in API version 62.0 and later.
OrderIdentifier
Type
string
Properties
Nillable
Description
The ID of the order associated with this event. Available with Revenue Cloud in API version 64.0 and later.
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
Id of the request that triggered the event.

Example

A user successfully runs a createOrUpdateAssetFromOrder request on an order with two order items. The published createAssetOrderEvent contains this information.
  • RequestId: 0001
  • AssetDetail
    • OrderItemId: 802XX0000000001
    • AssetId: 02iXX000000001
    • IsSuccess: True
  • AssetDetail
    • OrderItemId: 802XX0000000001
    • AssetId: 02iXX000000002
    • IsSuccess: True

Example

A user runs a createOrUpdateAssetFromOrder request on an order with two order items, but doesn't have Create access on assets. The request fails, and the published createAssetOrderEvent contains this information.
  • RequestId: 0002
  • AssetDetail
    • OrderItemId: 802XX0000000001
    • IsSuccess: False
    • ErrorCode: INSUFFICIENT_ACCESS
    • ErrorMessage: User doesn’t have Create Access to asset.
  • AssetDetail
    • OrderItemId: 802XX0000000001
    • IsSuccess: False
    • ErrorCode: INSUFFICIENT_ACCESS
    • ErrorMessage: User doesn’t have Create Access to asset.