Skip to main content

A type that describes the details of the subscription payload.

Types that use SubscriptionPayloadDetail

CreateSubscriptionRequestSubscriptionUpdateSubscriptionRequest

Calls that use SubscriptionPayloadDetail

POST
/subscription
GET
/subscription/{subscription_id}
GET
/subscription
PUT
/subscription/{subscription_id}

Fields

Field
Type
Description
deliveryProtocol
ProtocolEnum
The supported delivery protocol of the notification topic.

Note: HTTPS is currently the only supported delivery protocol of all notification topics.
format
FormatTypeEnum
The supported data format of the payload.

Note: JSON is currently the only supported format for all notification topics.
schemaVersion
string
The supported schema version for the notification topic. See the supportedPayloads.schemaVersion field for the topic in getTopics or getTopic response.