Interface MessageSubscription

For supported resources and message types, see Message Types. Messages will be delivered even if the Messages Query HTTP API is not enabled.

For MessageSubscriptions, the format of the payload is [MessageDeliveryPayload](ctp:api:type:MessageDeliveryPayload).
interface MessageSubscription {
    resourceTypeId: string;
    types?: string[];
}

Properties

resourceTypeId types?

Properties

Readonly resourceTypeId

resourceTypeId: string

Unique identifier for the type of resource, for example, order.

Optional Readonly types

types?: string[]

Must contain valid message types for the resource. For example, for resource type product the message type ProductPublished is valid. If no types of messages are given, the Subscription will receive all messages for this resource.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc