Saltar al contenido principal
POST
Enviar evento

Autorizaciones

Authorization
string
header
requerido

Clave API creada en la configuración de la organización.

Encabezados

Idempotency-Key
string

Clave única de la operación. Repetir la misma clave con el mismo cuerpo devuelve la respuesta original en lugar de ejecutarla de nuevo.

Cuerpo

application/json
name
string
requerido

Qué ocurrió, como order_shipped. Letras minúsculas, números y guiones bajos, empezando por una letra.

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

A quién le ocurrió. Envía al menos un identificador: id, external_id, tax_id, email o phone.

properties
object

Detalles del evento, en formato libre y sin claves reservadas. Hasta 200 claves en total, 5 niveles de profundidad y 100 elementos por lista.

occurred_at
string<date-time>

Cuándo ocurrió, en ISO 8601 con offset. Por defecto: el momento de la recepción.

external_id
string

ID del hecho en tu sistema. Reenviar el mismo name y external_id dentro de 90 días devuelve el evento original y no dispara nada.

Required string length: 1 - 255
backfill
boolean
predeterminado:false

Si es true, guarda el evento sin disparar flows. Úsalo para importar historial.

Respuesta

Ya existía un evento con el mismo name y external_id. Devuelve el evento original con duplicate: true; no se guarda ni se dispara nada de nuevo.

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

Cliente al que se vinculó el evento. Una clave solo de envío (events:write) recibe únicamente id.

flows
object[]
requerido

Flows activos que escuchan ese nombre de evento. Una lista vacía significa que ningún flow está escuchando.

backfill
boolean
requerido
livemode
boolean
requerido
external_id
string
properties
object

Propiedades tal como se enviaron. Ausente después de 30 días.

warnings
object[]

Presente solo cuando hay algo que avisar. Un aviso nunca sustituye a un error.

duplicate
boolean

Presente cuando la llamada devolvió un evento que ya existía con el mismo name y external_id.