Events
Every operation in this group: what it accepts, what it returns and the errors it can answer with.
Operations
Things your contacts did, sent by your own code: an order placed, a trial started, a plan changed. An event is stored against the contact for 90 days. It starts every live automation whose trigger names it, ends a wait step that was waiting for it, and can be read by a branch.
Send one with POST /events or up to 100 with POST /events/batch. Both take an Idempotency-Key header, so a retry never records an event twice. A key or an app may send 600 events a minute. Sending needs contacts:write and reading the events of a contact needs contacts:read.
POST/events
Send a contact event
Records that something happened to one contact, named by email or contactId. Every live automation whose trigger is this event name, and whose filters match properties, takes the contact in, and any wait step holding out for the name moves on. enrolled and resumed say what it set off.
An address nobody has saved is a 404 unless createContact is true, which adds it to the contacts first. An event sent with a test key is stored with mode test and starts nothing. A key or an app may send 600 events a minute.
Requires the contacts:write scope.
Headers
Idempotency-KeystringMakes a retry safe. The same key with the same event returns the stored event with
replayedtrue and starts nothing again. The same key with a different event is a 422idempotency_key_reuse.Up to 255 characters
Request body
namestringRequiredWhat happened, such as
order.placed: 1 to 100 letters, digits, dots, colons, dashes and underscores, starting with a letter or a digit. Names are matched exactly, case included.1 to 100 charactersemailstringThe contact the event is about, by email address. Send this or
contactId.Up to 320 charactersFormatemailcontactIdstringThe contact the event is about, by id. Send this or
email.1 to 64 characterspropertiesRecord<string, any>Anything worth keeping about the event, as a JSON object of at most 50 keys and 4 KB. An event trigger can filter on these, and steps can put them in an email or a contact field.
occurredAtstringWhen it happened, as an ISO 8601 instant. Left out, it is now. It cannot be in the future or more than 90 days ago.
Formatdate-timecreateContactbooleanAdd the address to the contacts when nobody has it yet. It needs
email. Left out or false, an unknown address is a 404contact_not_found.contactNamestringThe name to give a contact that
createContactadds.Up to 200 characters
Returns
A replay: the event this Idempotency-Key stored before.
Recorded.
Errors
- 404
contact_not_foundwhen nobody has that address or id andcreateContactis not true.- 422
invalid_eventwhen the name, the properties oroccurredAtbreak a rule or no contact is named,invalid_parameterorunknown_parameterfor a body of the wrong shape, oridempotency_key_reusewhen the key was already used for a different event.- 429
event_rate_limited: more events in a minute than the key or app may send.
The errors every operation can return400401403500Error catalog
Also available in
- TypeScript
events.send()- Python
events.send()- Ruby
events.send- PHP
events->send- Go
Events.Send- Java
events().send- C#
Events.SendAsync- CLI
openemail events send
POST/events/batch
Send contact events in a batch
Records up to 100 events in one call, each handled exactly as POST /events handles one, in order. One event failing does not stop the rest: accepted holds the ones that were stored and failed the ones that were not, each with the index it had in the request. A body of the wrong shape is refused whole. The batch counts as that many events toward the 600 a minute a key or an app may send.
Requires the contacts:write scope.
Headers
Idempotency-KeystringMakes a retry of the whole batch safe. Each event is remembered under the key and its position, so resend the same events in the same order.
Up to 255 characters
Request body
eventsobject[]RequiredThe events, 1 to 100 of them, each in the shape a single event takes.
1 to 100 itemsnamestringRequiredWhat happened, such as
order.placed: 1 to 100 letters, digits, dots, colons, dashes and underscores, starting with a letter or a digit. Names are matched exactly, case included.1 to 100 charactersemailstringThe contact the event is about, by email address. Send this or
contactId.Up to 320 charactersFormatemailcontactIdstringThe contact the event is about, by id. Send this or
email.1 to 64 characterspropertiesRecord<string, any>Anything worth keeping about the event, as a JSON object of at most 50 keys and 4 KB. An event trigger can filter on these, and steps can put them in an email or a contact field.
occurredAtstringWhen it happened, as an ISO 8601 instant. Left out, it is now. It cannot be in the future or more than 90 days ago.
Formatdate-timecreateContactbooleanAdd the address to the contacts when nobody has it yet. It needs
email. Left out or false, an unknown address is a 404contact_not_found.contactNamestringThe name to give a contact that
createContactadds.Up to 200 characters
Returns
What was stored and what was not.
Errors
- 422
invalid_parameterorunknown_parameterfor a body of the wrong shape, withparamnaming the event and the field, such asevents.3.name.- 429
event_rate_limited: the batch would pass the events a minute the key or app may send. Nothing was stored.
The errors every operation can return400401403404500Error catalog
Also available in
GET/events/names
List the event names in use
The distinct names of the events the workspace holds, in byte order, at most 100. It is what the app suggests when somebody picks the event that starts an automation. Events are kept for 90 days, so a name nothing has sent in that time is gone.
Requires the automations:read scope.
Returns
The names.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
GET/contacts/{email}/events
List the events of a contact
The events recorded for one contact in the last 90 days, the most recent first by when they happened. An app a member connected reads only the contacts that member added.
Requires the contacts:read scope.
Path parameters
emailstringRequiredThe contact, by email address, compared without case. The
contactIdan event or an enrollment carries works here too.
Query parameters
namestringOnly events with exactly this name.
1 to 100 characterslimitintegerRows per page, 1 to 200.
At least 1At most 200Default50cursorstringThe id of the last event on the previous page. Keyset, not offset: pass the previous page's
nextCursor. One that names nothing in this list is a 400invalid_cursor.
Returns
A page of events.
Errors
- 404
contact_not_foundwhen nobody you can reach has that address or id.
The errors every operation can return400401403422500Error catalog
Also available in
- TypeScript
contacts.listEvents()contacts.listAllEvents()contacts.iterateEvents()- Python
contacts.list_events()contacts.list_all_events()contacts.iterate_events()- Ruby
contacts.list_eventscontacts.list_all_eventscontacts.iterate_events- PHP
contacts->listEventscontacts->listAllEventscontacts->iterateEvents- Go
Contacts.ListEventsContacts.ListAllEventsContacts.IterateEvents- Java
contacts().listEventscontacts().listAllEventscontacts().iterateEvents- C#
Contacts.ListEventsAsyncContacts.ListAllEventsAsyncContacts.IterateEventsAsync- CLI
openemail contacts list-events- MCP
listContactEvents
Objects
ContactEventobject
objectstringRequired- One of
"contact_event" idstringRequiredThe id of the event.
contactIdstringRequiredThe id of the contact it is about.
emailstringRequiredThe address of that contact.
FormatemailnamestringRequiredWhat happened, as it was sent.
propertiesobjectRequiredThe properties the event was sent with. Empty when it had none.
occurredAtstringRequiredWhen it happened.
Formatdate-timemodestringRequiredtestwhen a test key sent it. A test event is stored and starts or resumes nothing.One of"live""test"createdAtstringRequiredWhen OpenEmail received it.
Formatdate-time
ContactEventBatchobject
objectstringRequired- One of
"contact_event_batch" acceptedobject[]RequiredThe events that were stored, in the order they were sent.
objectstringRequired- One of
"contact_event" idstringRequiredThe id of the event.
contactIdstringRequiredThe id of the contact it is about.
emailstringRequiredThe address of that contact.
FormatemailnamestringRequiredWhat happened, as it was sent.
propertiesobjectRequiredThe properties the event was sent with. Empty when it had none.
occurredAtstringRequiredWhen it happened.
Formatdate-timemodestringRequiredtestwhen a test key sent it. A test event is stored and starts or resumes nothing.One of"live""test"createdAtstringRequiredWhen OpenEmail received it.
Formatdate-timereplayedbooleanRequiredTrue when this
Idempotency-Keywas used before and the stored event is returned, with nothing started again.enrolledstring[]RequiredThe ids of the automations the event put the contact into.
resumedintegerRequiredHow many waits for this event it ended, across every automation the contact is in.
At least 0indexintegerRequiredWhere the event sat in the request, from 0.
At least 0
failedobject[]RequiredThe events that were not stored.
indexintegerRequiredWhere the event sat in the request, from 0.
At least 0codestringRequiredWhy, as the single call would answer:
invalid_event,contact_not_foundoridempotency_key_reuse.messagestringRequiredThe same in a sentence.
ContactEventListobject
objectstring- One of
"list" dataContactEvent[]hasMorebooleanTrue when another page follows. Pass
nextCursorback ascursorto read it.nextCursorstringThe id of the last row on this page, or null on the last page.
Can be null
ContactEventNameobject
objectstringRequired- One of
"contact_event_name" namestringRequiredAn event name the workspace holds events for.
ContactEventNameListobject
objectstring- One of
"list"
ContactEventResultobject
objectstringRequired- One of
"contact_event" idstringRequiredThe id of the event.
contactIdstringRequiredThe id of the contact it is about.
emailstringRequiredThe address of that contact.
FormatemailnamestringRequiredWhat happened, as it was sent.
propertiesobjectRequiredThe properties the event was sent with. Empty when it had none.
occurredAtstringRequiredWhen it happened.
Formatdate-timemodestringRequiredtestwhen a test key sent it. A test event is stored and starts or resumes nothing.One of"live""test"createdAtstringRequiredWhen OpenEmail received it.
Formatdate-timereplayedbooleanRequiredTrue when this
Idempotency-Keywas used before and the stored event is returned, with nothing started again.enrolledstring[]RequiredThe ids of the automations the event put the contact into.
resumedintegerRequiredHow many waits for this event it ended, across every automation the contact is in.
At least 0