Topics covering webhook creation & management, event handling, Pub/Sub, and Eventbridge, in Shopify apps.
Hi,
We have a webhook created via the admin page (Settings -> Notifications -> at the bottom of the page) for Order Payment that is for the topic "orders/paid". Based on our logs, I see the following custom Shopify headers, i.e. the ones starting with "X-Shopify-", present in each request:
X-Shopify-Api-Version 2022-10
X-Shopify-Hmac-Sha256 ...
X-Shopify-Order-Id 123456...
X-Shopify-Shop-Domain foobar.myshopify.com
X-Shopify-Test false
X-Shopify-Topic orders/paid
X-Shopify-Webhook-Id deadbeef..
The page https://shopify.dev/apps/webhooks mentions:
In addition to the message payload, each webhook message has a variety of headers containing additional context.
For example, an orders/create webhook can include the following headers:
The following header fields are used:
Also, the page https://shopify.dev/apps/webhooks/configuration/https#step-5-verify-the-webhook states:
Each webhook request includes a base64-encoded X-Shopify-Hmac-SHA256 header
Now, I think I have read all documentation about webhooks I could find on Shopify, yet I wasn't able to find answers to my below questions:
Any help to answer my questions is appreciated.
Solved! Go to the solution
This is an accepted solution.
Hey there, unfortunately we don't have documentation on each set of headerss used for every Shopify topic, and they do differ slightly based on topic. However you can always rely on the `X-Shopify-Hmac-Sha256`, the `X-Shopify-Webhook-Id`, the `X-Shopify-API-Version` and the `X-Shopify-Shop-Domain` being there
mrad | Developer @ Shopify
- Was my reply helpful? Click Like to let me know!
- Was your question answered? Mark it as an Accepted Solution
- To learn more visit Shopify.dev or the Shopify Web Design and Development Blog
This is an accepted solution.
Hey there, unfortunately we don't have documentation on each set of headerss used for every Shopify topic, and they do differ slightly based on topic. However you can always rely on the `X-Shopify-Hmac-Sha256`, the `X-Shopify-Webhook-Id`, the `X-Shopify-API-Version` and the `X-Shopify-Shop-Domain` being there
mrad | Developer @ Shopify
- Was my reply helpful? Click Like to let me know!
- Was your question answered? Mark it as an Accepted Solution
- To learn more visit Shopify.dev or the Shopify Web Design and Development Blog
Hey Mrad,
Thank you for your reply.
Do you know whether there are any plans to improve the webhooks documentation, and possibly to include something like what I asked originally? When could we expect any improvement to be available?