Create a subscription (returns the signing secret ONCE)

POST

/admin/v1/webhooks/subscriptions

const url = 'https://your-store.example.com/admin/v1/webhooks/subscriptions';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"url":"https://example.com","events":["order.created"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://your-store.example.com/admin/v1/webhooks/subscriptions \
  --header 'Content-Type: application/json' \
  --data '{ "url": "https://example.com", "events": [ "order.created" ] }'

Request Body^required

application/json

object

url

required

string format: uri

<= 2048 characters

events

required

Array<string>

>= 1 items <= 10 items

Allowed values: order.created order.paid order.shipped order.cancelled order.refunded order.partially_refunded refund.issued product.created product.updated product.deleted

Create a subscription (returns the signing secret ONCE)

Request Body^required

Responses

201

Create a subscription (returns the signing secret ONCE)

Request Body required

Responses

201

Request Body^required