Update webhooks firing only when includeFields are modified

Something that I see happening in the API but that I’m having trouble finding documentation on when searching…

When you register an update webhook with includeFields, it only fires when those fields are modified.

This is actually absolutely awesome - I’m just surprised that when I try searching to confirm this functionality, every reference I find says the opposite - that the webhook will fire normally regardless of what is in includeFields.

I’ve tested it just now with products/update webhook topic with includeFields = id, title

1 Like

Hey @kalen :waving_hand: - did a bit of digging into this to confirm for you.

Right now, includeFields doesn’t strictly filter which events trigger a webhook. But, by limiting the data in the webhook message, it can cause some updates (where the included fields don’t change) to be skipped if they happen close together (within a short “debounce” window on our end). This is because the message content would be a repeat, and we aim to limit sending duplicate info.

However, once that short debounce window passes, you would still receive a webhook for an update even if only fields not in your includeFields were changed.

So, it reduces webhooks with identical payloads during that brief period, but doesn’t permanently stop notifications for all other field changes. Hope this helps - let me know if I can clarify anything as always!

Ahh interesting. Thanks for the clarification!

1 Like