Events/Notifications and Webhooks
Introduction
Events are created as part of operations being processed by Eagle Eye's AIR platform. The purpose of this guide is to provide a high-level overview and describe what these events are. It also provides details of each type of event that the AIR platform can produce.
What are Events?
Real-time events are triggered in response to completed operations within the AIR platform. The event notifications are surfaced via various mechanics, and can be consumed by external client systems to trigger bespoke actions in downstream systems or feed data into a Data Warehouse.
Example Webhook Usage
Upon the completion of a continuity account (a mechanism in AIR to encourage repeat transactions or purchases), an event can be sent to a CDP or Marketing Automation platform that triggers a workflow to send an email to the customer congratulating them on completing the journey and push a reward into the customer wallet.
Online Test ServicesEagleEye actively blocks the use of online services such as "webhook.site" as a security measure. If you wish to receive data for testing, we recommend the temporary use of an SFTP mechanism (this does not scale) or setting up a temporary delivery mechanism in the retailer's own infrastructure to receive the events.
Event Types
AIR has two different types and mechanics for sending a notification:
- Atomic Operation Events: These events contain details of all the data entities in AIR that are created or updated due to a given API call.
- Account Transaction Events: These events contain a single account transaction and the data associated with these. They are less rich events and support fewer delivery mechanics than the Atomic Operation Events.
The following pages contain details about these two notification types, including:
- Data Structures
- Delivery Mechanics
- Retry Mechanics
Re-try and De-Duplication
Although AIR does its best to only deliver a notification once to a customer, there are occasions where a replay of notification data is required. To prevent duplicate notification processing, clients should implement a deduplication strategy to prevent duplicate data from being processed more than once. The following pages will identify the unique data point to power this de-duplication mechanism.
Updated about 4 hours ago
