Skip to main content
POST
Send a custom event

Authorizations

Authorization
string
header
required

Your secret key, for example sk_live_.... Send it as Authorization: Bearer sk_live_.... A sk_test_... key runs in test mode.

Body

application/json
event
string
required

Event name, matching ^[a-zA-Z0-9_.:-]{1,64}$, lower-cased on arrival.

Example:

"first_deposit"

contact
object
required

Who the event or action is for. Provide at least one identifier.

attributes
object

Contact traits merged onto the contact record. Max 50 keys.

payload
object

Event-specific data, kept with the event. Max 16 KB.

idempotencyKey
string

Your dedup key. Strongly recommended.

Example:

"deposit:0xabc:9184"

occurredAt
string<date-time>

When it happened. Rejected if older than 7 days or more than 5 minutes in the future.

test
boolean

Dry run: reports what it would match but sends nothing.

Response

Accepted.

accepted
boolean
deduplicated
boolean
idempotencyKey
string