Skip to content

Quickstart ​

Send your first notification in under a minute.

1. Get Your API Key ​

  1. Sign in to your Sendivent dashboard
  2. Go to Settings → API Keys
  3. Copy your API key

Start with a test_* key for development. See Sandbox vs Production.

2. Create an Event ​

  1. Go to Events
  2. Click Create Event
  3. Name it welcome
  4. Add a template (subject + body)

Events are environment-specific

Create events in sandbox when using test_* keys. Events created in production won't be accessible with sandbox keys (and vice versa).

3. Send ​

bash
curl -X POST https://api-sandbox.sendivent.com/v1/send/welcome \
  -H "Authorization: Bearer test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "your@email.com",
    "payload": { "name": "Alice" }
  }'

WARNING

Sandbox sends real notifications. Use your own email to verify delivery.

Response

json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "event": "welcome",
  "status": "accepted"
}

The id is your notification identifier. Use it to track status.

4. Check Activity ​

Go to Activity in the dashboard to see your message status and any errors. Or call GET /v1/notifications/{id} with the ID from the response.

Going Live ​

When ready for production:

  1. Switch to your live_* API key
  2. Change the URL to https://api.sendivent.com
  3. Verify your sending domain

Next Steps ​

Prefer an SDK? ​

bash
pip install sendivent
bash
composer require sendivent/sdk
bash
npm install @sendivent/sdk

See Python, PHP, or Node.js SDK docs.

Released under the MIT License.