Webhook Event Publishing

Set up webhook events to ensure smooth interaction between services and systems.

Here you can find an overview of the Emporix Webhook Service, along with its features and benefits.

• Looking for code tutorials? Check out the Webhook Service guide.

• Looking for API reference? Check out the Webhook Service in the Emporix API Reference.

Purpose

To move towards an event-driven architecture, we are introducing the Webhook Event Publishing functionality. This feature, implemented through the Emporix API Webhook Service, allows external systems to subscribe to internal events published by the Commerce Engine. Thanks to the Webhook Service, you do not need to call specific API endpoints to look for recent changes in services — you will be automatically notified instead.

Features

The Webhook Service introduces the following features:

Feature	Description
Events	All actions that take place in the Emporix API are considered events. For example, creating and updating a catalog in the Emporix API Catalog Service are both considered events.
Event subscription management	You can manage notifications for your Emporix tenant by subscribing to and unsubscribing from particular events.
Event Gateway	The Event Gateway is a dashboard where you pre-configure endpoints to receive notifications about events you have subscribed to in the Webhook Service. The Event Gateway acts as an intermediary, as it passes notifications from the Webhook Service directly to your tenant.
Statistics	You can retrieve statistics for the Shared Account strategy on the number of events successfully sent to the endpoints that you earlier configured in the Event Gateway.
Strategy configuration	Possible to configure within the Emporix Management Dashboard if Shared Account, Licensed Account - Svix, or Other - HTTP strategy is used.
Specific Target URLs	For the Other - HTTP strategy, it is possible to define different target URLs for different events.

Webhooks strategies

You can apply one of the following strategies to your tenant:

• Svix-Shared - default strategy allowing you to use the shared Svix subscription offered by Emporix

• Svix - strategy that allows you to connect your own Svix licence

• HTTP - strategy that provides possibility to receive events notification as HTTP requests to a declared URL

Overview

The Emporix Webhook Event Publishing process consists of the following sequence of events:

1. When an event that you subscribed to takes place, a message is sent to the Webhook Service.

2. The Webhook Service forwards the message to the Event Gateway.

3. The Event Gateway passes the event to your pre-configured endpoint for this particular event.

For example, if a catalog is created in the Emporix environment, a notification is sent to the Webhook Service. The service passes the message to the Event Gateway. If you configured the Create a new catalog endpoint beforehand, you will receive the notification from the Event Gateway that a new catalog has been created.

With the Svix-shared strategy, the maximum number of events per tenant is limited to 5000/month. The limit resets on the first day of each month. After you exceed the set limit, the requests do not get sent. For further information about the limits, please contact the Sales department at [email protected].

For more information about webhooks usage, see Webhooks. For more information on HMAC configuration, see HTTP Webhook Strategy - HMAC Configuration. To see example integration with external application through webhooks, see:

• HTTP Webhook Strategy - Integration with Azure Service Bus

• HTTP Webhook Strategy - Integration with Amazon Simple Queue Service (SQS)