@gradientedge/commercetools-utils
    Preparing search index...

    Interface MessageDeliveryPayload

    This payload is sent for a MessageSubscription.

    interface MessageDeliveryPayload {
        createdAt: string;
        id: string;
        lastModifiedAt: string;
        notificationType: "Message";
        payloadNotIncluded?: PayloadNotIncluded;
        projectKey: string;
        resource: Reference;
        resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
        resourceVersion: number;
        sequenceNumber: number;
        version: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    createdAt id lastModifiedAt notificationType payloadNotIncluded? projectKey resource resourceUserProvidedIdentifiers? resourceVersion sequenceNumber version

    Properties

    createdAt: string

    Date and time (UTC) the resource was initially created.

    id: string

    Unique ID of the message.

    lastModifiedAt: string

    Date and time (UTC) the resource was last modified.

    notificationType: "Message"

    Identifies the payload.

    payloadNotIncluded?: PayloadNotIncluded

    If the payload does not fit into the size limit or its format is not accepted by the messaging service, the payloadNotIncluded field is present.

    projectKey: string

    key of the Project. Useful for processing notifications if the Destination receives them from multiple Projects.

    resource: Reference

    Reference to the resource that triggered the notification.

    resourceUserProvidedIdentifiers?: UserProvidedIdentifiers

    User-defined unique identifiers of the resource.

    resourceVersion: number

    Version of the resource on which the update was performed.

    sequenceNumber: number

    Used to ensure all messages of the resource are processed in correct order. The sequenceNumber of the next message of the resource is a successor of the sequenceNumber of the current message.

    version: number

    Last seen version of the resource.

    Settings

    Member Visibility

    On This Page

    Properties