Data format

The data sent in response to system events comes from the corresponding Admin API gateways. Their format is in accordance with the API documentation in the version set for the respective webhook.

Gateways currently used:

Events regarding customers - GET clients/clients

• POST products/products/search events
• GET orders/orders events
• GET returns/returns events
• GET rma/rma returns events

API permissions

The events that can be defined for a webhook depend on the read permissions defined for the API key they are associated with.

Required permissions:

• Custome events - CMS (read)
• Product events - PIM (read)
• Order events - OMS (read)
• Return events - OMS (read)
• Rma events - OMS (read)

If you change (narrow down) the API key permissions, the saved webhook settings are not modified, but events based on gateways to which access has been revoked will not be sent. An analogous situation occurs when the key is deactivated.