Quickstart (10 minutes)

This guide gets you from zero to a recorded message_id and delivery_runs in approximately ten minutes.

Prerequisites

• A SendPromptly account and Project
• An Environment (create one in the dashboard)
• An Environment Token (create under Environment → Tokens)

1. Create or copy an environment token

2. Send a minimal event (replace placeholders):

curl -X POST "https://api.sendpromptly.example/api/v1/events" \
	-H "Authorization: Bearer ${ENV_TOKEN}" \
	-H "Content-Type: application/json" \
	-H "Idempotency-Key: ${UUID}" \
	-d '{
		"event_key": "user.signup",
		"payload": {"name":"Alice","occurred_at":"2026-02-01T12:00:00Z"},
		"recipient": {"email":"[email protected]"}
	}'

Expected result: HTTP 201 with JSON containing message_id and delivery_runs. Visit the Message Log in the portal to inspect delivery attempts, payloads, and replay actions.

Notes

• Always supply Idempotency-Key (UUID) for POST /events to avoid duplicate processing.
• Use the portal to add webhook endpoints or email provider connections before sending events if you expect immediate delivery.