less than a minute read • Updated an hour ago

API filter query string reference

The zoom and fields query strings available for each webhook resource, and what data they include in the payload.

The JSON webhook uses the API as its data source. By default, it sends only the base resource as the payload — for example, the transaction webhook sends just the transaction resource, without item or address details. The API filter query string lets you adjust what’s included. A default query string is provided for each resource when creating a webhook in the admin.

Resource	Purpose	Query string
Transactions	Provide all data related to the transaction (default)	`zoom=applied_taxes,billing_addresses,custom_fields,customer,discounts,items,items:item_category,items:item_options,payments,shipments`
Transactions	Send just the transaction ID and status	`fields=id,status`
Subscriptions	Provide all data related to the subscription (default)	`zoom=customer,customer:default_billing_address,customer:default_shipping_address,transaction_template,transaction_template:discounts,transaction_template:items,transaction_template:items:item_category,transaction_template:items:item_options,transaction_template:applied_coupon_codes,transaction_template:custom_fields`
Customers	Provide all data related to the customer (default)	`zoom=default_billing_address,default_shipping_address,default_payment_method,customer_addresses`
Transaction Logs	Provide all data related to the log (default)	`zoom=transaction_log_details,transactions`
Changelog	Nothing to zoom	—

Need Help?

Did this article answer your questions? Need help with anything? Please click below to contact us.