Events API

The Events API is designed to facilitate the submission and processing of events in a loyalty system. This API provides flexible functionality to support various event types, including standard and custom events, while accommodating both single and bulk submissions.

Key Features

1. REST-Like Behavior

   • The API follows REST principles but has variations in the payload format depending on the event type.

   • The custom-events endpoint supports bulk submissions, making it ideal for handling multiple events in one request.

2. Event Submission

   • custom-event Endpoint:

     • Accepts a single custom event.

     • Fully compliant with REST standards.

     • Best suited for cases where individual event submission is required.

   • custom-events Endpoint:

     • Accepts an array of custom events, supporting bulk submission.

     • Payload size can be up to 1GB. However, it is recommended to keep the payload under 1MB to maintain optimal performance.

3. Ordered and Unordered Modes

   • The API can operate in two modes:

     • Ordered Mode: Ensures that all events associated with the same member (memberExternalId or memberInternalId) are processed in the order they were submitted.

       • If memberInternalId is missing, the system performs a lookup to resolve memberExternalId to memberInternalId. This process blocks event execution until the lookup is completed.

     • Unordered Mode: Events are processed as they arrive, and there is no guarantee of sequential processing.

4. Multi-System Support

   • The spaceId parameter allows the API to address specific loyalty spaces.

   • This enables the coexistence of multiple loyalty systems within the same infrastructure, ensuring clear separation and targeted event handling.

5. Authentication and Communication

   • The API uses HTTP/HTTPS as the communication protocol.

   • Requests are authenticated via ApiKey, ensuring secure access to the endpoint.