Skip to main content

webhook

Register and manage webhook event subscriptions. 6 API commands.

All webhook commands share these flags:

FlagShortDescription
--paramsPath/query parameters as JSON
--dataRequest body as JSON (inline, @file, or - for stdin); only on commands that take a request body
--jq-qjq expression to filter output
--dry-runPreview the request without executing

create​

Register a new webhook.

shell
shoplazza webhook create --data '<json_body>'

The request body is a webhook object that must include address (notification URL) and topic (event name).

Example​

shell
shoplazza webhook create --data '{
  "webhook": {
    "topic": "orders/create",
    "address": "https://example.com/hook"
  }
}'

list​

List all registered webhooks.

shell
shoplazza webhook list

Example​

shell
shoplazza webhook list --format table

get​

Get details of a specific webhook.

shell
shoplazza webhook get --params '{"id":"123"}'

update​

Update a webhook subscription.

shell
shoplazza webhook update --params '{"id":"123"}' --data @webhook.json

Example​

shell
shoplazza webhook update --params '{"id":"123"}' --data '{
  "webhook": {
    "address": "https://example.com/webhooks/orders-v2"
  }
}'

delete​

Delete a webhook subscription.

shell
shoplazza webhook delete --params '{"id":"123"}'

count​

Count registered webhooks.

shell
shoplazza webhook count
On this page