Events

Discover how to subscribe to and manage events in Omnium, including webhook integration, retry policies, and event logging for efficient event handling.

Events & Webhooks

For most operations that occur in Omnium, whether executed via API or UI, an event is fired. You can subscribe to these events by registering an event subscriber.

Event Subscribers

An event subscriber listens to events and sends a message to the type of subscribers. Currently, the supported types of subscribers are:

Webhooks
Azure Storage Queues
Azure Service Bus
Apache Kafka

Event subscribers are registered in the Omnium UI. You will find it under Configuration => Event subscriptions. When registering a subscriber, you select which filters you want enabled for the current subscriber, ensuring that you only receive the event messages that interest you.

The example below shows how you would register a webhook subscriber with the following options:

Only order events
With order type: Click and collect
With status: Ready for pickup
With store: BikeSport Drammen

Event Data

Here is an example of how the payload would look for an event message for the registered webhook:

{
    "timestamp": "2022-12-04T07:23:07.6380021Z",
    "message": "Workflow completed",
    "className": "Order",
    "subClassName": "ClickAndcollect",
    "objectId": "EPIC0001",
    "category": "Workflow",
    "market": "NOR",
    "storeId": "epic_webshop_no",
    "user": "Ola Nordmann",
    "userId": "olanordmann@omnium.no",
    "status": "ReadyForPickup"
}

Retry Policies

Our retry policy is 3 attempts with the following delays: 1 second, 5 seconds, and 15 seconds. This does not apply to responses with status codes 200-299, 404, 400, and 429.

Event Log

On most entities, such as an order, you can inspect the event log in the Omnium UI by pressing the three dots in the top right corner and selecting Log. Event subscription results, such as the status code returned by webhooks, will also be logged but cannot be subscribed to due to potential circular references.