Webhooks

​

Relay Webhooks

Using webhooks a channel can subscribe to the lifecycle of products and orders in the external commerce platform. To learn more about the creation and management of webhooks please refer to the webhooks section of our docs, https://docs.violet.io/managing-webhooks.

There are currently four possible Relay webhooks that can be subscribed to.

RELAY_OFFER_CREATED - this event will trigger anytime a product is created in the external commerce platform. The body of the webhook will contain a single Violet Offer object.

RELAY_OFFER_UPDATED - this event will trigger anytime a product is updated in the external commerce platform. The body of the webhook will contain a single Violet Offer object.

RELAY_OFFER_REMOVED - this event will trigger anytime a product is deleted in the external commerce platform. The body of the webhook will contain a single Violet Offer object.

RELAY_ORDER_UPDATED - this event will trigger anytime an order is updated in the external commerce platform. The body of the webhook will contain a single Violet Order object with a single nested Violet Bag object.

Each Relay webhook event that is sent to your remote endpoint will contain an X-Violet-Entity-External-Id header with a string value. This value is the ID of the resource in the external commerce platform and should not exceed 64 characters.