Skip to main content
This guide is your first letter in the mail: in a few steps you go from account to your first HTTP 202, confirmation that Notifique received your send.

​
What is this guide?

It’s the shortest path from account to first send. Documentation by devs, for devs: direct, no legalese. Notifique is your product’s messaging infrastructure. Queues, retries, and protocols stay on our side; you get a predictable REST API.

​
What will you accomplish?

By the end of this guide:
  • Account created in the dashboard
  • API Key saved (sk_test_ or sk_live_)
  • First message queued on SMS or WhatsApp

​
Where to start?

For your first send, SMS or WhatsApp is usually the shortest path: Other channels (email, push, Telegram) have their own quick starts when you need them.

​
Step by step

​
1. Create your account

Create your account on the Dashboard Complete onboarding for full access to your workspace.

​
2. Create an API Key

In the dashboard, open Developer → API Keys. Name it, select scopes for the channel you will test, and copy it right away.
Keys start with sk_live_... or sk_test_.... After you close the modal, we do not show the full value again. Store it in .env or your project’s secret manager.
  • Production (sk_live_...): real sends, uses credits, message can reach a real phone
  • Sandbox (sk_test_...): same endpoints, no real delivery. Check Developer → Sandbox inbox
We recommend starting with sk_test_.... More in Sandbox and API Keys.

​
3. Send your first message

Replace YOUR_API_KEY with the key you generated.

​
SMS

Use your number in international format (e.g. 5511999999999). Message text must be between 9 and 160 characters.
Expected response: HTTP 202 with the message queued. With sk_live_, it goes to the carrier. With sk_test_, open Developer → Sandbox inbox to see the simulated send. Full guide: SMS Quick Start.

​
WhatsApp

You need a paired instance and scopes whatsapp:instances:create, whatsapp:instances:list, and whatsapp:send. Create instance and get the QR
In the response, use connection.base64 to show the QR and scan it on your phone. When status is ACTIVE, note instance.id. Send text
Expected response: HTTP 202. With sk_live_ and an active instance, the message goes to WhatsApp. With sk_test_, check Developer → Sandbox inbox. Full guide: WhatsApp Quick Start.

​
Done?

If you got HTTP 202, the basic integration works. The letter left your system and entered Notifique’s queue.

​
Next steps

  • API Keys: scopes, best practices, and key rotation
  • Sandbox: test safely before go-live
  • Webhooks: receive delivery alerts on your server
  • Logs: debug API calls