Skip to main content

Quickstart

This guide takes you from zero to receiving your first notification using the Orqestra sandbox. No credit card, no account setup — just follow the steps.

:::info Sandbox credentials

FieldValue
Tenant nameOrqestra Demo Sandbox
Tenant idfaa1a8c4-0975-40cd-beda-a8f63c4e9388
TierSANDBOX
Admin UI login (username)demo
Admin UI passwordTryOrqestra2026!
API key (x-api-key)aa636e6c67592d513c37b6b6f64d2d122781178edb37429c41b945f59c910ecb

The sandbox is a real Orqestra instance. Events are processed, templates render, and logs are recorded — but deliveries go through a demo sender email so nothing lands in a real inbox. :::

Step 1 — Log in​

Open the Admin UI at your Orqestra URL and sign in with the sandbox credentials above.

You'll land on the Tenant Dashboard. If you see a "Setup Checklist" banner at the top, that's your guide — we'll complete each step below.

Step 2 — Add a provider​

Before anything can be delivered, Orqestra needs to know which service to use for dispatch.

  1. Click Providers in the left sidebar.
  2. Click Add Provider.
  3. Select Resend (or SendGrid if you prefer).
  4. Paste your Resend API key. If you don't have one, sign up for free at resend.com — the free tier is generous.
  5. Set a Sender Email and Sender Name (e.g. notifications@yourdomain.com / My App).
  6. Click Save.

Once saved, the provider appears in your list and the locked nav items unlock.

:::tip No API key yet? You can still explore the sandbox. Templates, the playground editor, and log pages become available once a provider is configured. Without one, events are accepted but nothing is dispatched. :::

Step 3 — Verify a template exists​

Orqestra uses templates to know what message to send for each event type.

  1. Click Templates in the sidebar.
  2. You should see the sandbox demo templates: SANDBOX_WELCOME_EMAIL, SANDBOX_PING_EMAIL, and SANDBOX_ALERT_EMAIL.
  3. Click on SANDBOX_PING_EMAIL to inspect it. It listens for the event type sandbox.ping.
  4. Confirm it shows Active status.

If it's not active, toggle it on.

Step 4 — Fire the event​

Open your terminal and run:

curl -X POST https://YOUR_ORQESTRA_URL/api/v1/events/trigger \
  -H "x-api-key: YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "eventType": "sandbox.ping",
    "payload": {
      "userId": "demo-user-001",
      "recipientEmail": "you@example.com"
    },
    "variables": {
      "name": "World"
    }
  }'

Replace YOUR_ORQESTRA_URL with your server URL and YOUR_SANDBOX_API_KEY with the API key shown in the Admin UI under Account or the Dashboard header.

A successful response looks like:

{
  "success": true,
  "data": {
    "eventId": "evt_...",
    "status": "accepted"
  }
}

"accepted" means Orqestra received the event and queued it for dispatch. Delivery is asynchronous and happens within a few seconds.

Step 5 — Check the Logs​

  1. Click Logs in the sidebar.
  2. You should see a new entry for the sandbox.ping event with status SENT or DELIVERED.
  3. Click the row to see full details: channel, provider, timestamp, and recipient.

If you see FAILED, check:

  • Is your provider API key correct?
  • Is the sender_email a verified domain in your email provider's dashboard?
  • Does the template event type match sandbox.ping exactly?

See Troubleshooting for a full checklist.

You did it 🎉​

You just sent your first notification through Orqestra. From here:

  • Concepts → — Understand how tenants, events, templates, and providers fit together.
  • Sending Events → — Full API reference for the events endpoint, including multi-channel routing and idempotency.
  • Templates Guide → — Write MJML emails and Handlebars templates for SMS and push.