Skip to main content
POST
/
api
/
v2
/
platform
/
webhooks
/
subscribers
Create a Webhook Subscriber
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    subscriber: {
      url: 'https://www.url.com/',
      active: true,
      subscriptions: ['order.created', 'order.completed', 'product.updated']
    }
  })
};

fetch('http://{defaultHost}/api/v2/platform/webhooks/subscribers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "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
subscriber
object
required

Response

Record created

data
object
required