Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Queues
Realtime
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
What you set up once, how a message is sent, and what a delivery receipt tells you.
Email is sent through Notify. You verify a domain once, write a template, and then send a message: one notification to one recipient. Notify checks that the recipient has not been suppressed and has not turned the topic off, sends it, and closes every delivery with a receipt from the mail provider.
All of it is on the one API at https://api.sylphx.com.
#The pieces
| Field | Type | What it is |
|---|---|---|
Email domain | mail_domains | A domain you send from, for example mail.example.com. You publish the DNS records it gives you (DKIM, SPF, return path) and verify it. |
Template | templates | The From address (on a verified domain), subject and bodies of an email, with variables. Messages pin the version they were sent with. |
Recipient | recipients | A person you notify: email addresses, language, time zone and per-topic preferences. Your own user id goes in external_key. |
Message | messages | One notification to one recipient on one topic. Send it with notify.messages.create. |
Suppression | suppressions | An address that is never sent to. Bounces, complaints and unsubscribes write one themselves. |
A message has a state (accepted, suppressed, delivering, delivered,
failed, cancelled or rate_limited) and one entry in deliveries per
channel, each with a provider_receipt once the provider has taken it. A
template can limit how often one recipient is sent that template.
#Send a message
sylphx notify messages send \
--parent orgs/acme/projects/shop/envs/production \
--recipient orgs/acme/projects/shop/envs/production/recipients/ada \
--topic billing \
--template orgs/acme/projects/shop/envs/production/templates/receiptThe quickstart sets up the domain, template and recipient first, and sends a test message that is rendered and captured without leaving Sylphx.
#Send as a mailbox
A message can instead be sent as one of your mailboxes
with its subject and bodies inline (mailbox and content), and can answer a
thread with parent_message_id and references. A mailbox also receives
email: each arrival is an inbound email you can read.
#What is not served
Senders and broadcasts are declared in the API reference and are not routed, so there is no bulk send. Send one message per recipient.