Skip to main content
POST
Envio de eventos via API (chave de API)

Authorizations

Authorization
string
header
required

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

Body

application/json
type
enum<string>
required

Tipo da conversão. subscription_created: nova assinatura. one_time_purchase: compra avulsa. trial_converted: trial convertido em assinatura paga. upgrade: upgrade de plano. custom: evento de conversão customizado.

Available options:
subscription_created,
one_time_purchase,
trial_converted,
upgrade,
custom
Example:

"subscription_created"

amountCents
integer
required

Valor da conversão em centavos (inteiro). Ex.: 1990 = R$ 19,90.

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

1990

customer
object
required

Dados do cliente que originou a conversão.

sourceEventId
string
required

Identificador único do evento de origem na loja, usado para deduplicação/idempotência permanente.

Required string length: 1 - 255
Example:

"order_2026-0001"

kind
enum<string>
required

Tipo do evento: conversion registra uma nova conversão (venda/assinatura) atribuída a um afiliado.

Available options:
conversion
currency
enum<string>
default:BRL

Moeda da conversão. Apenas BRL (Real brasileiro).

Available options:
BRL
occurredAt
any

Data/hora em que a conversão ocorreu (ISO-8601). Default: momento do recebimento.

Example:

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

productId
string

Identificador do produto vendido. Confrontado com applicableProductIds da regra vigente.

Required string length: 1 - 255
Example:

"plan_pro_monthly"

programId
string

Programa ao qual a conversão pertence. Obrigatório quando a organização tem mais de um programa.

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

"prog_01J9Z3K8N2QF4T7B9XP0WMD5RC"

clickId
string

Identificador do clique a ser atribuído (matching por click_id).

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

"clk_01J9Z3K8N2QF4T7B9XP0WMD5RC"

visitorId
string

Identificador do visitante rastreado (matching por visitor_id).

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

"vis_01J9Z3K8N2QF4T7B9XP0WMD5RC"

emailHash
string

Hash SHA-256 do e-mail do cliente, usado no matching por email_hash.

Pattern: ^[a-f0-9]{64}$
Example:

"a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3"

fingerprint
string

Hash SHA-256 da impressão digital do dispositivo, usado no matching por fingerprint.

Pattern: ^[a-f0-9]{64}$
Example:

"a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3"

couponCode
string

Código de cupom de afiliado utilizado na compra (matching por coupon).

Required string length: 1 - 64
Example:

"MARIA10"

gclid
string

Google Click Identifier, propagado no snapshot de atribuição.

Required string length: 1 - 255
Example:

"Cj0KCQiA_gclid_example"

Response

200 - application/json

Default Response

outcome
enum<string>
required

Resultado do processamento. processed: evento aplicado com sucesso. replayed: já havia sido processado antes (mesmo sourceEventId reenviado). unmatched: nenhuma conversão correspondente encontrada. skipped: reconhecido, mas não aplicado por não atender a uma regra de negócio. ignored: evento sem relevância de negócio.

Available options:
processed,
replayed,
unmatched,
skipped,
ignored
Example:

"processed"

reason
string | null
required

Motivo do resultado quando aplicável (ex.: por que foi ignorado ou pulado). null quando processado normalmente.

Example:

"unsupported event type"

conversionId
string | null
required

ID da conversão afetada (prefixo conv_ + ULID). null quando nenhuma conversão foi correspondida.

Example:

"conv_01J9Z3K8N2QF4T7B9XP0WMD5RC"

commissionIds
string[]
required

IDs das comissões criadas ou afetadas pelo evento (prefixo comm_ + ULID).

Example: