Skip to content
Postiix

Quickstart

Six steps from a new account to a delivered transactional email. For full endpoint details once you're integrated, see the API reference.


1. Create a project

Every send happens inside a project. Create an Organization if you don't have one yet, then create a project inside it — each project has its own API keys, templates, contacts, and Email Activity, isolated from your other projects.

2. Get an API key

Open your project's API Keys settings. Each project has two keys: a live key and a test key. Copy whichever you need — you'll use the live key for real sends and the test key for development.

Store it as an environment variable; never commit it to source control.

Test Live

3. Use Test mode

Authenticate with your project's test key and Postiix runs the full send pipeline — templates, variables, suppression checks, logging — without a message ever reaching a real inbox. Integrate and verify your code path first, then switch to your live key when you're ready to send for real.

4. Send your first email

Call the transactional send endpoint with a template ID and the variables it needs.

Terminal
curl -X POST "https://api.postiix.com/v1/transactional/send" \
  -H "ql-api-key: YOUR_TEST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "you@example.com",
    "template_id": "your-template-id",
    "variables": {
      "first_name": "Alex"
    }
  }'

A successful response looks like:

{
  "success": true,
  "id": "0100019..."
}

See the full transactional send reference for every field, header, and error case.

5. Inspect Email Activity

Open Email Activity in your project. Your test send appears immediately with a Sent status — the exact request payload is available if you need to debug it.

6. Events and webhooks, as needed

If you'd rather route product events to Postiix and let it resolve the right transactional template — instead of specifying template_id directly — use the events API. And if your application needs to react to delivery outcomes, configure an outbound webhook from your project's dashboard.

Both are covered in full in the API reference.