Skip to main content
POST
Record event

Authorizations

Authorization
string
header
required

Organization API key, sent as Authorization: Bearer boom_org_....

Body

application/json
name
string
required

Event name, e.g. "checkout_completed". Letters, numbers, underscores only.

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9_]+$
externalId
string
required

Your stable id for this event (idempotency key). Re-recording returns created: false.

Required string length: 1 - 255
timestamp
string<date-time>

When the event occurred, ISO 8601. Defaults to now if omitted.

Pattern: ^(?:(?:\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))$
personExternalId
string

Subject: the person externalId this event is about.

Required string length: 1 - 255
customObjectType
string

Subject: the custom-object type name. Must be paired with customObjectExternalId.

Required string length: 1 - 255
customObjectExternalId
string

Subject: the custom-object externalId. Must be paired with customObjectType.

Required string length: 1 - 255
properties
object

Free-form event payload.

Response

Success

created
boolean
required

false when the externalId was already recorded (idempotent).

eventId
string
personId
string
personExternalId
string
customObjectType
string
customObjectExternalId
string