Events

An event is each occurrence sent to the platform via the POST /events endpoint.

While the event type defines the contract, the event represents the actual data that happened in your operation (for example: a payment attempt, an authentication, or a registration update).

Every event belongs to an event type

To send an event, you must specify in the type attribute which event type it represents.

This value must be the ID of a previously configured and active event type in the account.

If the event type does not exist or is inactive, the API rejects the submission.

Minimum submission structure

When submitting to POST /events, the main fields are:

  • type: event type ID;
  • id: unique identifier of the event;
  • attributes: event data according to the fields configured in the type;
  • timestamp (optional): date and time of the occurrence. If not provided, the platform uses the reception time.

How validation works

Event validation follows the event type configuration:

  • required fields must be sent;
  • data types must be in the expected format;
  • unknown fields can be ignored or rejected, depending on the event type configuration.

This ensures consistency in ingestion and prevents out-of-contract events from affecting metrics and monitors.

Practical example

  1. You register an event type with ID transaction.
  2. Define the expected fields, such as amount and status.
  3. Send an event to POST /events with type: transaction.
  4. The platform validates the payload and, if correct, processes the event for use in analyses, metrics, and monitors.