Webhooks
Create Webhook
Creates a webhook that POSTs the events you subscribe to, for the stores you choose, as signed
JSON. The signing secret is returned once here, so save it to verify the X-Signature header.
Requires the user.webhooks.create permission.
POST
Create a webhook
You can hold up to 25 webhooks per user, each scoped to one or more of
your stores. URLs must be HTTP or HTTPS, and any that resolve to private or
reserved addresses are rejected.
Body
application/json
The webhook's URL, the events to subscribe to, and the stores it covers
Represents a form for configuring webhooks. This form includes a URL for the webhook, a list of event types, and a list of store IDs the webhook should apply to.
Response
The object was successfully created.
Represents a default generic response for API endpoints.
Last modified on August 2, 2026