Skip to main content
POST
Validate event without storing it

Authorizations

Authorization
string
header
required

API key created in the organization settings.

Body

application/json
name
string
required

What happened, such as order_shipped. Lowercase letters, digits, and underscores, starting with a letter.

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

Who it happened to. Send at least one identifier: id, external_id, tax_id, email, or phone.

properties
object

Event details, free-form and with no reserved keys. Up to 200 keys in total, 5 levels of depth, and 100 items per list.

occurred_at
string<date-time>

When it happened, in ISO 8601 with offset. Default: the moment it is received.

external_id
string

ID of this fact in your system. Sending the same name and external_id again within 90 days returns the original event and triggers nothing.

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

If true, stores the event without triggering flows. Use it to import history.

Response

What sending it would return. Nothing was stored.

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

Customer the event was linked to. A send-only key (events:write) receives id only.

flows
object[]
required

Active flows that listen to this event name. An empty list means no flow is listening.

backfill
boolean
required
livemode
boolean
required
external_id
string
properties
object

Properties as they were sent. Absent after 30 days.

warnings
object[]

Present only when there is something to warn about. A warning never replaces an error.

duplicate
boolean

Present when the call returned an event that already existed with the same name and external_id.