Skip to content
SendSignal Docs

Quickstart

1. Create an account and API key

Section titled “1. Create an account and API key”

Sign up at app.sendsignal.dev, then create an API key under Platform → API Keys. Keys look like ss_ followed by 48 hex characters and are shown once; store yours somewhere safe. Keys can have full access or be scoped to sending only.

While your team is in test mode (the default for new teams), you can send from an unverified domain to try things out. Before production traffic, verify a domain.

2. Send an email

Section titled “2. Send an email”

Authenticate every request with your API key as a bearer token:

Terminal window
curl https://api.sendsignal.dev/emails \
  -H "Authorization: Bearer ss_..." \
  -H "Content-Type: application/json" \
  -d '{
    "from": "Acme <hi@acme.com>",
    "to": "user@example.com",
    "subject": "Hello",
    "html": "<p>Hi</p>"
  }'

The API responds immediately with the email object (status: "queued"); delivery happens asynchronously and every state change becomes an event you can receive by webhook or the live SSE stream.

Already have an app that speaks SMTP? Point it at the SMTP relay instead: same pipeline, no code changes.

3. Watch it land

Section titled “3. Watch it land”

Open the console’s Activity view to watch delivery events live, or fetch them from the API:

Terminal window
curl https://api.sendsignal.dev/emails/{id}/events \
  -H "Authorization: Bearer ss_..."

Next steps

Section titled “Next steps”