Documentation

Getting started

Create an API key and an instance, connect a channel and send your first message.

Sendjade connects an account that you own (a WhatsApp number, or a Telegram or MAX bot) and exposes it through a REST API. One instance is one connected account. This page takes you from nothing to a sent message.

Before you startLive

  • A Sendjade account (sign up with your company name, then confirm your email).
  • For WhatsApp: a phone with WhatsApp or WhatsApp Business installed, ideally a spare test number. For Telegram or MAX: a bot token (see Channels).
  • A workspace API key (sjk_...) for your scripts and servers: Console, API keys, Create. It is shown once. Give it the scopes it needs: instances:write and instances:read to create and connect, messages:send to send. See Authentication.
  • Two API styles. Native REST at https://api.sendjade.com/api/v1 (Authorization: Bearer sjk_...) for apps and servers. Green-API-compatible at https://api.sendjade.com/waInstance{idInstance}/{method}/{apiTokenInstance} (instance id and token in the URL) for tools like Make, Zapier, n8n and spreadsheets.
  • The hostname above is illustrative until your own deployment is live.
  • Open the console and choose Create instance. Pick the channel and give it a name.
  • Copy the idInstance and the apiTokenInstance (the token). The token is shown once, only its hash is stored. If you lose it, press Generate new token on the instance page.
  • WhatsApp: press Connect, then on the phone open WhatsApp, Settings, Linked devices, Link a device and scan the QR code. Telegram or MAX: press Connect and paste the bot token. There is no QR code.
  • The status changes to Authorized and your number (or bot name) appears.

Do the same through the APILive

Create an instance, connect and fetch the QR code (WhatsApp)
BASE=https://api.sendjade.com/api/v1
# export SENDJADE_API_KEY=sjk_...   (Console > API keys; scopes instances:write, instances:read, messages:send)

# 1. Create the instance. Save "instance.id", "instance.idInstance" and "apiToken" (the token is shown once).
curl -s -X POST $BASE/instances -H "Authorization: Bearer $SENDJADE_API_KEY" \
  -H "Content-Type: application/json" -d '{"name":"Adaeze Bakery"}'

# 2. Connect, then fetch the QR code (a PNG data URL) and scan it in WhatsApp > Linked devices
curl -s -X POST $BASE/instances/$INSTANCE_UUID/connect -H "Authorization: Bearer $SENDJADE_API_KEY"
curl -s $BASE/instances/$INSTANCE_UUID/qr -H "Authorization: Bearer $SENDJADE_API_KEY"

Send your first messageLive

Once the instance is CONNECTED, send with your API key on the native routes, or with only the idInstance and token on the Green-style routes. A success response means the message was accepted for sending, not delivered. On Telegram and MAX the chatId is the numeric chat id instead of a phone number (see Channels).

Green-style: POST sendMessage
curl -s -X POST https://api.sendjade.com/waInstance$ID_INSTANCE/sendMessage/$API_TOKEN_INSTANCE \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: first-message-1" \
  -d '{"chatId":"2348012345678@c.us","message":"Hello from Sendjade"}'

# -> { "idMessage": "3EB0A1B2C3D4E5F6A7" }

Where do I find idInstance and the token?

In the console, open Instances and click your number. The idInstance is shown on that page. The apiTokenInstance was shown once when you created the instance; press Generate new token to get a fresh one (the old one stops working).