create_webhook
Subscribe to Shopify events like order creation or product updates. Send filtered payloads to your HTTPS endpoint with optional field selection to reduce bandwidth.
Instructions
Subscribe to a Shopify event topic and have payloads POSTed to your HTTPS endpoint. Common topics: ORDERS_CREATE, ORDERS_PAID, ORDERS_FULFILLED, PRODUCTS_CREATE, PRODUCTS_UPDATE, INVENTORY_LEVELS_UPDATE, CUSTOMERS_CREATE, APP_UNINSTALLED. Use includeFields to receive only specific fields in the payload (reduces bandwidth and avoids leaking unrelated data). metafieldNamespaces opts in to including metafields from the listed namespaces. callbackUrl must be HTTPS in production. Returns the new subscription's GID; verify delivery is working with a few real events before relying on it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| topic | Yes | WebhookSubscriptionTopic, e.g. 'ORDERS_CREATE', 'ORDERS_PAID', 'PRODUCTS_UPDATE', 'INVENTORY_LEVELS_UPDATE', 'APP_UNINSTALLED'. See Shopify docs for full list. | |
| callbackUrl | Yes | HTTPS endpoint that will receive the webhook POSTs. | |
| format | No | JSON | |
| includeFields | No | Optional: only include these fields in the payload (reduces payload size). | |
| metafieldNamespaces | No | Optional: include metafields from these namespaces in the payload. |