API Overview

SendPromptly is built around event ingestion. Your application sends one event and SendPromptly handles template resolution, delivery runs, retries, and tracking.

Base URL

1

https://app.sendpromptly.com/api

Core endpoint

1

POST /v1/events

Required headers:

• Authorization: Bearer sp_{env}_{token}
• Idempotency-Key: <unique-key>

What happens after ingestion

1. The event is validated and accepted.
2. Matching templates are found for email and webhook channels.
3. Delivery runs are created immediately or scheduled.
4. Attempts are tracked with status, latency, and errors.

Full reference and examples

• Docs landing: /docs/
• Generated reference (Scribe): /api/reference/

Quick request example

1
2
3
4
5
6
7
8
9

curl -X POST https://app.sendpromptly.com/api/v1/events \
  -H "Authorization: Bearer sp_prod_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Idempotency-Key: order-100023-20260207" \
  -H "Content-Type: application/json" \
  -d '{
    "event_key": "order.created",
    "recipient": {"email": "[email protected]", "name": "A. Customer"},
    "payload": {"order_id": "O-100023", "total": 125.50, "currency": "CAD"}
  }'