Skip to main content
POST
/
admin
/
webhooks
Create Webhook
curl --request POST \
  --url https://api.headlesscommerce.io/v1/admin/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "is_active": true,
  "secret": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API Key. Example: sk_live_xxxxx or pk_live_xxxxx

Body

application/json
​
url
string<uri>
required
​
events
string[]
required

Events to subscribe. Example: product.created, order.confirmed, payment.completed Full list: product., variant., inventory., cart., order., payment., fulfillment., refund., customer., discount.

Response

201 - application/json

Created

​
id
string
​
url
string
​
events
string[]
​
is_active
boolean
​
secret
string

Only returned on creation

​
created_at
string<date-time>