Webhooks

Add product webhook

The retailer/e-commerce platform webhook URL triggered when Jay requires a full product description.

The request sent from Jay is a POST request to this URL with a payload like:

{
  "sku": "string",
  "lang": "de",
  "country": "DE"
}

The header field X-API-Key is set to the token associated to the retailer/e-commerce platform. This token can be used for authentication by the retailer/e-commerce platform and shall be placed to the header field X-API-Key again when sending information to Jay.

Update all products webhook

The retailer/e-commerce platform webhook URL triggered when Jay requires an update of all volatile product information (stock count, prices, etc.).

The request sent from Jay is a PUT request to this URL. The header field X-API-Key is set to the token associated to the retailer/e-commerce platform. This token can be used for authentication by the retailer/e-commerce platform and shall be placed to the header field X-API-Key again when sending information to Jay.