Skip to main content
GET
Envelope completo do evento (payload + metadados)

Authorizations

Authorization
string
header
required

Chave de API (prefixo rstr_) enviada como Authorization: Bearer rstr_....

Path Parameters

eventId
string
required

Identificador do evento de domínio (prefixo evt_ + ULID).

Pattern: ^evt_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"evt_01J9Z3K8N2QF4T7B9XP0WMD5RC"

Response

200 - application/json

Default Response

id
string
required

Identificador único do evento de domínio (prefixo evt_ + ULID).

Example:

"evt_01J9Z3K8N2QF4T7B9XP0WMD5RC"

organizationId
string
required

Organização dona do evento.

Example:

"org_01J9Z3K8N2QF4T7B9XP0WMD5RC"

type
string
required

Tipo do evento de domínio (ex.: affiliate.approved, conversion.created).

Example:

"affiliate.approved"

version
integer
required

Versão do schema do payload deste tipo de evento.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

aggregateType
string
required

Tipo do agregado ao qual o evento pertence (ex.: affiliate, conversion).

Example:

"affiliate"

aggregateId
string
required

Identificador do agregado afetado (ID com prefixo + ULID).

Example:

"aff_01J9Z3K8N2QF4T7B9XP0WMD5RC"

payload
object
required

Dados específicos do evento; a estrutura varia conforme o type e a version.

metadata
object
required

Metadados de auditoria do evento (ator e origem).

occurredAt
string<date-time>
required

Momento em que o fato de negócio ocorreu (ISO-8601).

Example:

"2026-06-13T12:00:00.000Z"

recordedAt
string<date-time>
required

Momento em que o evento foi registrado pela plataforma (ISO-8601).

Example:

"2026-06-13T12:00:00.000Z"