Documentation

Webhooks

Webhooks are configured in the fmcgProducts UI (Webhook events), not through the JSON API. The instance POSTs application/json to your targetUrl.

When it fires

A webhook can run when a product is created or updated. You can limit an event to create only. The event can also be limited by:

  • Unit type (base, case, display, pallet, and so on)
  • An optional formula that must evaluate true
  • A disabled flag

If the same event is already running for that product, a second POST is skipped.

Payload

The JSON object can include:

  • source - URL of the product in fmcgProducts, when the instance provides it
  • One property per configured payload field (grid fields use FieldId_1, FieldId_2, …)
  • Extra key/value pairs configured on the event

Keyword fields can be sent as display text when that option is on.

You can also configure HTTP headers on the event (for example a shared secret). The POST is a normal JSON body; there is no separate webhook REST API to poll.

What to do with it

A usual pattern is: receive the POST, then call details or status with your API key if you need the full current record.