Skip to main content
POST
/
webhooks
/
{id}
/
test
Send a test webhook
curl --request POST \
  --url https://api.shoppex.io/dev/v1/webhooks/{id}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "order:created"
}
'
{
  "data": {
    "message": "<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_...

Path Parameters

id
string
required

Body

application/json
event
enum<string>
required
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

Response

Default Response

data
object
required