Pular para o conteúdo principal
POST
Validar evento sem gravar

Autorizações

Authorization
string
header
obrigatório

API key criada nas configurações da organização.

Corpo

application/json
name
string
obrigatório

O que aconteceu, como order_shipped. Letras minúsculas, números e sublinhados, começando por letra.

Maximum string length: 64
Pattern: ^[a-z][a-z0-9_]*$
customer
object
obrigatório

Com quem aconteceu. Envie ao menos um identificador: id, external_id, tax_id, email ou phone.

properties
object

Detalhes do evento, em formato livre e sem chaves reservadas. Até 200 chaves no total, 5 níveis de profundidade e 100 itens por lista.

occurred_at
string<date-time>

Quando aconteceu, em ISO 8601 com offset. Padrão: o momento do recebimento.

external_id
string

ID do fato no seu sistema. Reenviar o mesmo name e external_id em até 90 dias devolve o evento original e não dispara nada.

Required string length: 1 - 255
backfill
boolean
padrão:false

Se true, grava o evento sem disparar flows. Use para importar histórico.

Resposta

O que o envio devolveria. Nada foi gravado.

object
string
obrigatório
Allowed value: "event"
id
string
obrigatório
Pattern: ^evt_[A-Za-z0-9_-]+$
name
string
obrigatório
occurred_at
string<date-time>
obrigatório
received_at
string<date-time>
obrigatório
customer
object
obrigatório

Cliente a que o evento foi ligado. Uma chave só de envio (events:write) recebe apenas id.

flows
object[]
obrigatório

Flows ativos que escutam esse nome de evento. Lista vazia significa que nenhum flow está escutando.

backfill
boolean
obrigatório
livemode
boolean
obrigatório
external_id
string
properties
object

Propriedades como foram enviadas. Ausente depois de 30 dias.

warnings
object[]

Presente apenas quando há algo a avisar. Um aviso nunca substitui um erro.

duplicate
boolean

Presente quando a chamada devolveu um evento que já existia com o mesmo name e external_id.