The Events API is used to record events in Antavo synchronously, meaning each event is processed immediately when the request is received. The API validates and records the event before returning a response.
The synchronous event submission is useful when:
- Immediate confirmation that the event was successfully recorded is required.
- The volume of events is low to moderate, so processing can be completed quickly without impacting performance.
- The result is shown instantly to the customer (e.g., “You earned 100 points” or “Coupon applied successfully”).
For high-volume or non–real-time use cases, use the Async Events API. The Async Events API support only customer profile-, point addition-, and transaction-related events.
There are two ways of submitting events to Antavo via the Events API:
- Single event submission: An individual action is written to a single customer’s event stream.
- Bulk event submission: Multiple events are submitted in a single API call. This is commonly used for recording a single action across multiple customers and is frequently used in integrations.
InfoThe bulk event submission endpoint can process up to 50 events per request. Additional events included in a request will not be rejected, but performance may be affected.
The Events API follows a RESTful approach and events are submitted via POST requests. Each event can include several attributes, and events can be submitted using external IDs. Antavo can also accept and process events with nullattributes.
The list of currently available events and their corresponding attributes can be found on the Events page.
Personally identifiable information returned from Events API endpoints can be suppressed using the Events API configuration module. When enabled, no customer information will be present in any response.
API Principles
The Events API follows RESTful principles, utilizing standard HTTP methods to interact with resources. All responses are formatted in JSON, ensuring easy integration into user interfaces.
Security and Compliance
All server-to-server calls must comply with the API security protocol and signing procedure and adhere to the defined API rate limits.