Interface CloudEventsPayload

The CloudEventsFormat represents event data in a way that conforms to a common specification. The payload can be found inside the data field.

interface CloudEventsPayload {
    data: DeliveryPayload;
    dataref?: string;
    id: string;
    sequence?: string;
    sequencetype?: string;
    source: string;
    specversion: string;
    subject: string;
    time: string;
    type: string;
}

Properties

data dataref? id sequence? sequencetype? source specversion subject time type

Properties

Readonlydata

data: DeliveryPayload

MessageDeliveryPayload, ResourceCreatedDeliveryPayload, ResourceUpdatedDeliveryPayload, or ResourceDeletedDeliveryPayload.

Optional Readonlydataref

dataref?: string

The URI from which the message can be retrieved if messages are enabled. Only set for MessageSubscriptions.

Readonlyid

id: string

Unique identifier of the event.

Optional Readonlysequence

sequence?: string

Corresponds to the sequenceNumber of a MessageSubscription. Can be used to process messages in the correct order.

Optional Readonlysequencetype

sequencetype?: string

"Integer"

Readonlysource

source: string

The default REST URI of the ReferenceTypeId that triggered this event, including the project key.

Readonlyspecversion

specversion: string

The version of the CloudEvents specification which the event uses.

Readonlysubject

subject: string

Unique identifier of the resource that triggered the event.

Readonlytime

time: string

Corresponds to the lastModifiedAt of the resource at the time the event was triggered.

Readonlytype

type: string

The type is namespaced with com.commercetools, followed by the ReferenceTypeId, the type of Subscription (either message or change), and the message or change type. For example, com.commercetools.product.message.ProductPublished or com.commercetools.order.change.ResourceCreated.

Settings

Member Visibility

On This Page

Properties