Flows

Notifications

Send transactional email to your users and optionally fan the same event out to your registered webhook endpoints — one call, two channels.

Send a notification

POST/v2/notifications/send
App token
Request body
user_idstringoptionalTarget user (resolves email)
emailstringoptionalExplicit recipient address
subjectstring
required
Email subject
htmlstring
required
HTML body
textstringoptionalPlain-text fallback
fanout_eventstringoptionalWebhook event type to emit
payloadobjectoptionalData for the webhook event
curl
curl -X POST http://localhost:8000/v2/notifications/send \
  -H "Authorization: Bearer <app_access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "trader@example.com",
    "subject": "Your account is funded",
    "html": "<h1>Congrats!</h1><p>You are now funded.</p>",
    "fanout_event": "account.funded",
    "payload": { "prop_account_id": "prop_123" }
  }'
200 OK
{ "email_sent": true, "webhook_deliveries_queued": 2 }

Provide a recipient

Pass either user_id (we resolve the email) or an explicit email. Add fanout_event to also notify your backend via webhooks.