Events

An event is a record of something your product did that's worth emailing about: a signup, a purchase, a plan change, a completed onboarding step. Your backend posts events to Pombo, and Pombo decides what mail they produce.

Posting an event

POST /api/v1/events            scope: events:write
{
  "event": "donation.received",
  "email": "[email protected]",
  "properties": { "amount": "$50", "campaign_title": "Winter Appeal" }
}

properties is free-form. Unknown email addresses create the contact. A 202 means the event was recorded.

What an event can drive

The same event, keyed by name, can do three things at once:

1. Start a sequence whose trigger is that event name. See event-triggered sequences.
2. Fire a transactional email bound to that event name. See sending a transactional email.
3. Count as a conversion for a sequence goal of type "event received".

A sequence and a transactional template can both be bound to donation.received, and both run. They're independent.

The payload in templates

Everything in properties is available as {{ event.* }} in whatever the event fires: {{ event.amount }}, {{ event.campaign_title }}, plus {{ event.name }} for the event's own name. This is per event, not per contact, so two events for the same person each carry their own data.

Seeing what's arrived

Settings, Events shows every distinct event name you've sent, how many in the last seven days, which sequences and goals use each one, and a live log of individual events. It's the place to confirm your backend is posting what you think it is.