Skip to main content
POST
/
webhooks
Create a webhook
curl --request POST \
  --url https://api.shoppex.io/dev/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": [
    "order:created"
  ],
  "type": "paylix"
}
'
{
  "data": {
    "id": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key with the Bearer scheme. Get your key from Dashboard → Settings → API Keys. Format: Authorization: Bearer shx_...

Body

application/json
​
url
string<uri>
required
​
events
enum<string>[]
required
Required array length: 1 - 12 elements
Available options:
order:created,
order:updated,
order:partial,
order:paid,
order:cancelled,
order:disputed,
order:created:product,
order:updated:product,
order:partial:product,
order:paid:product,
order:cancelled:product,
order:disputed:product,
product:created,
product:edited,
product:stock,
product:dynamic,
query:created,
query:replied,
feedback:received,
subscription:trial:started,
subscription:trial:ended,
subscription:created,
subscription:updated,
subscription:renewed,
subscription:cancelled,
subscription:upcoming,
subscription:trial:started:product,
subscription:trial:ended:product,
subscription:created:product,
subscription:updated:product,
subscription:renewed:product,
subscription:cancelled:product,
subscription:upcoming:product
​
type
enum<string>
default:paylix
Available options:
paylix,
zapier

Response

Default Response

​
data
object
required