Track a custom event

POST/events

Records a named event for a contact (contact_id or email; an unknown email creates the contact unless create_contact is false). properties (or Resend's payload) become merge variables of the sequence it starts. An idempotency_key (or Idempotency-Key header) makes a retry return the first event; the same key with a different event is a 409 invalid_idempotent_request.

Authorization

apiKey

AuthorizationBearer <token>

A project API key: Authorization: Bearer s0_…

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Match^[A-Za-z0-9][A-Za-z0-9 _.:/-]{0,127}$

event?string

Match^[A-Za-z0-9][A-Za-z0-9 _.:/-]{0,127}$

contact_id?string

Stamp0 ct_ identifier

Match^ct_[0-9A-Za-z]{16}$

email?string

Lengthlength <= 254

properties?

payload?

occurred_at?string

Match

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Formatdate-time

idempotency_key?string

Length1 <= length <= 256

create_contact?boolean

Response Body

`application/json`

curl -X POST "https://example.com/events" \  -H "Content-Type: application/json" \  -d '{}'

{  "object": "event",  "id": "string",  "contact_id": "string",  "created": true}

Track a custom event

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

202application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`