Can I rely on the X-Shopify-Topic header?

Can I rely on the X-Shopify-Topic header?

Philo01
Shopify Partner
4 0 0

When looking at the webhook documentation, `X-Shopify-Topic` is given in an example request but the table listed below the documentation does not mention `X-Shopify-Topic`.

 

I want to send all webhooks to the same URL example.com/webhooks and use the header to identify the topic. So for this reason I want to ensure that I can rely on this header being present.

 

Replies 2 (2)

Liam
Shopify Staff
2862 313 813

Hi Philo01,

 

You should see the `X-Shopify-Topic` header in every webhook that is sent by Shopify - which will include the topic title. 

Liam | Developer Advocate @ 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

Philo01
Shopify Partner
4 0 0

Hi Liam,

Thanks for your reply.

I do see the `X-Shopify-Topic` header in every webhook but I want to make sure it's not going away, given it's not listed in the documentation:

 

"The following header fields are used:

X-Shopify-Hmac-Sha256

X-Shopify-Webhook-Id

X-Shopify-Shop-Domain

X-Shopify-Triggered-At"

 

Can you confirm that I can rely on `X-Shopify-Topic` being always sent?