POST
/
api
/
v2
/
platform
/
webhooks
/
subscribers
Create a Webhook Subscriber
curl --request POST \
  --url http://{defaultHost}/api/v2/platform/webhooks/subscribers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "subscriber": {
    "active": true,
    "subscriptions": [
      "order.created",
      "order.completed",
      "product.updated"
    ],
    "url": "https://www.url.com/"
  }
}'
{
  "data": {
    "id": "9",
    "type": "subscriber",
    "attributes": {
      "url": "https://www.url9.com/",
      "active": true,
      "subscriptions": [
        "*"
      ],
      "created_at": "2022-11-08T19:35:59.334Z",
      "updated_at": "2022-11-08T19:35:59.334Z"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Response

201
application/vnd.api+json

Record created

The response is of type object.