Subscribe to the Store events

Add subscription for a store events

application/json

Request Body

• callbackUrl uri required

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

• eventName string required

  Possible values: [orderInProgress, orderShipped, orderDelivered]

  Event name for the subscription

Responses

• 201

---

Subscription added

application/json

• Schema
• Example (from schema)

---

Schema

• subscriptionId string

{
  "subscriptionId": "AAA-123-BBB-456"
}

POST /store/subscribe

Request

Base URL

https://api.atomgit.com

Body

{
  "callbackUrl": "https://myserver.com/send/callback/here",
  "eventName": "orderInProgress"
}

curl -L -X POST 'https://api.atomgit.com/store/subscribe' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "callbackUrl": "https://myserver.com/send/callback/here",
  "eventName": "orderInProgress"
}'

curl -L -X POST 'https://api.atomgit.com/store/subscribe' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "callbackUrl": "https://myserver.com/send/callback/here",
  "eventName": "orderInProgress"
}'

curl -L -X POST 'https://api.atomgit.com/store/subscribe' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "callbackUrl": "https://myserver.com/send/callback/here",
  "eventName": "orderInProgress"
}'

curl -L -X POST 'https://api.atomgit.com/store/subscribe' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "callbackUrl": "https://myserver.com/send/callback/here",
  "eventName": "orderInProgress"
}'

curl -L -X POST 'https://api.atomgit.com/store/subscribe' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "callbackUrl": "https://myserver.com/send/callback/here",
  "eventName": "orderInProgress"
}'

curl -L -X POST 'https://api.atomgit.com/store/subscribe' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "callbackUrl": "https://myserver.com/send/callback/here",
  "eventName": "orderInProgress"
}'

curl -L -X POST 'https://api.atomgit.com/store/subscribe' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "callbackUrl": "https://myserver.com/send/callback/here",
  "eventName": "orderInProgress"
}'