Skip to main content

Customizing your webhooks

This guide introduces the different ways in which you can customize the webhooks you receive.

Anchor to Filter eventsFilter events

Filters are made up of user-defined rules and can be applied to your webhook subscriptions.

Filters gate whether or not certain event messages are delivered, based on these rules.

Filters allow you to control how many webhooks you receive. Think of a filter as a binary gate for your webhooks.

What are filters

Anchor to Modify payloadsModify payloads

Shopify provides you with a way to modify the payload you receive when you subscribe to webhook topics.

Payload modifications allow you to specify which fields you will receive per webhook. Think of this as a way to control what information you get.

Unlike filters, which always return the same payload, this feature enables you to specify what subset of information is most relevant to your use case from a webhook. This can be especially useful in instances where you might be most interested in only a subset of fields from very large payloads, like the orders/updated webhook topic.

What are payload modifications

Anchor to Customize your webhooks experienceCustomize your webhooks experience

When combined, filters and modified payloads are a powerful way to tailor the webhooks you receive for your use case.

When specifying filters and included fields, all fields that are in the filter must also be included in the included fields for that webhook.

Filters with Modified Payloads

[webhooks]
api_version = "2024-01"

[[webhooks.subscriptions]]
topics = ["products/update"]
uri = "https://example.com/webhooks"
include_fields = ["id", "status", "product_type", "variants.taxable", "variants.price", "variants.title", "updated_at"]
filter = "id:* AND status:active AND (product_type:Music OR product_type:Movies) AND variants.taxable:true AND variants.price:>=100 AND variants.title:'The Miseducation of'"
Was this page helpful?