Skip to content

Events

An event is a named notification definition. When you call POST /v1/send/welcome, Sendivent looks up the welcome event and uses its templates to send a message.

Events define the available templates. Routing chooses which one is used at send-time.

What Events Are For

  • Define notification types (welcome, password-reset, order-shipped)
  • Define which channels are available for each notification
  • Attach templates per channel (and optionally per language)
  • Optionally define multi-step sequences (send, wait, condition)

Creating Events

  1. Go to Events in your dashboard
  2. Click Create Event
  3. Fill in:
FieldDescriptionExample
NameURL-friendly identifierorder-confirmation
Display NameHuman-readable nameOrder Confirmation
ChannelsAvailable delivery methodsEmail, SMS, Slack, Push, Telegram, WhatsApp, Discord

Templates are configured per channel (and optionally per language). See Templates.

Event Naming

Use clear, lowercase names with hyphens:

  • welcome
  • password-reset
  • order-shipped
  • invoice-ready
  • team-invite
  • verification-code

Avoid names like notification1 or email-v2.

Sequences (optional)

Events can define a sequence — a series of steps that run automatically when the event fires.

Step types:

TypeWhat it does
SENDSend a message on a channel
WAITPause for a duration (up to 30 days)
CONDITIONBranch based on contact data or payload
ENDStop the sequence

Simple events (no sequence defined) auto-generate a single SEND step behind the scenes. You don't need to configure a sequence for basic use.

Use sequences for multi-channel fallback (email first, SMS if not delivered after 1 hour) or drip campaigns (welcome email → feature tips after 3 days).

Sending to an Event

bash
curl -X POST "https://api.sendivent.com/v1/send/welcome" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "user@example.com",
    "payload": { "name": "Alice" }
  }'

Common Pitfalls

  • Event doesn't exist — create it in the dashboard before sending
  • Missing template — add a template for the channel you expect to deliver
  • Invalid name — use order-shipped, not order shipped
  • Blank variables — ensure payload includes keys used in the template

See Also

Released under the MIT License.