Webhooks

Relay is a different product to Checkout with a different set of supported Webhooks. You can read about Checkout webhooks here

Using Webhooks, you can subscribe to the lifecycle of products and orders in the external commerce platform, without any extra integration effort on your part.

Violet provides you with the following webhooks to subscribe to to track Products and Orders across all the merchants you are interested in:

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.

Relay Webhook Event Headers

Each Relay webhook event that is sent to your remote endpoint will include the following headers:

X-Violet-Entity-External-Id - This string value is the ID of the resource in the external commerce platform and should not exceed 64 characters.\

X-Violet-Merchant-Id - This integer value is the ID of the merchant in Violet.\

X-Violet-Topic - This enum value will be one of the webhook topics described above (example RELAY_OFFER_CREATED).

You can learn more about Violet webhook headers here.