Subscribe to the Store events

Add subscription for a store events

Request Body schema: application/json
callbackUrl
required
string <uri>

This URL will be called by the server when the desired event will occur

eventName
required
string
Enum: "orderInProgress" "orderShipped" "orderDelivered"

Event name for the subscription

Responses

Callbacks

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "subscriptionId": "AAA-123-BBB-456"
}

Callback payload samples

Callback
Content type
{
  • "orderId": "123",
  • "timestamp": "2018-10-19T16:46:45Z",
  • "status": "inProgress"
}