AssetRenewInitiatedEvent

Notifies subscribers when the process started by the /asset-management/assets/collection/actions/initiate-renew REST request is complete. If the process is successful, use this event to learn about the renewal order that was created. If the process isn’t successful, use the RevenueTransactionErrorLog records 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
Flows
Processes
Pub/Sub API
Streaming API (CometD)

Subscription Channel

/event/AssetRenewInitiatedEvent

Event Delivery Allocation Enforced

Special Access Rules

This object is available when Subscription Management is enabled.

Fields

AssetRenewErrorDetailEvents

Type: AssetRenewErrorDtlEvent[]

Properties: Nillable

Description: Contains a list of error messages and error codes if the request failed. This field is available in API versions 55.0 and 56.0 only.

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.

RenewalRecordId

Type: string

Properties: Nillable

Description: The ID of the renewal record; for example, the renewal order. If the process failed, this field is null.

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 requestIdentifier parameter in the /asset-management/assets/collection/actions/initiate-renew response. Use this ID to identify the event for a specific request.