Getting Started with SendPromptly

Getting Started

This guide helps you ship your first event-driven notification flow with SendPromptly, from project setup to delivery verification.

Prerequisites

A SendPromptly account
Access to a backend service where you can make server-side HTTP requests
A test recipient email and optional webhook endpoint

Step 1: Create a project

In app.sendpromptly.com, create a project for your application or product boundary. Projects isolate templates, tokens, and delivery logs.

Step 2: Create environments

Set up at least dev and prod environments. Generate a dev token first so you can test safely without mixing live traffic.

Step 3: Create a template

Create an email template mapped to an event_key such as order.created or workspace.created. Include variables that match your payload contract (for example order_id or workspace_name).

Step 4: Send your first event

1
2
3
4
5
6
7
8
9
curl -X POST https://app.sendpromptly.com/api/v1/events \
  -H "Authorization: Bearer sp_dev_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Idempotency-Key: sample-order-1001-created" \
  -H "Content-Type: application/json" \
  -d '{
    "event_key": "order.created",
    "recipient": {"email": "[email protected]", "name": "Dev User"},
    "payload": {"order_id": "O-1001", "total": 49.99, "currency": "USD"}
  }'

Step 5: Verify delivery runs

Open delivery logs in the dashboard and confirm:

Event ingestion status is successful
Expected channel runs were created
Run status reaches success (or shows actionable error details)

Step 6: Move to production safely

Create production templates and tokens in prod
Keep idempotency keys deterministic per business event
Add alerting for ingestion failures and retry spikes