Skip to the documentation
Knowledge base

Events from your app

Tell OpenEmail what a contact did in your product, to start an automation or end a wait.

Details

  • An event says a contact did something in your product: placed an order, started a trial, upgraded a plan. You send it with POST /events, naming the contact by address and the event by a name of your choosing, such as order.placed.
  • An event starts every live automation whose trigger names it, and it ends a wait that was holding out for it. A yes or no step can also ask whether a contact did an event in the last days.
  • Properties ride along with the event, up to 50 keys. A trigger can filter on them and an email can use them as template values, so an order number or a plan name reaches the message.
  • Events are kept for 90 days, and the People tab of an automation shows what your product reported about each contact. A key or app may send 600 events a minute, and one batch call records up to 100.
  • Events are on the REST API as POST /events and POST /events/batch, in every SDK as events.send and events.sendBatch, on the command line as openemail events, and on the MCP server as sendContactEvent and sendContactEvents.