API reference
Everything is set up from your dashboard. Work through the steps below; the API base URL for your
integration is https://wacentraconnectapi.com/api/v1.
Auth#
- Create an account. On the website click Get started, register, then enter the code sent to your email.
- Sign in. Click Log in and enter your email and password. If your workspace asks for a sign-in code, enter the one sent to your email.
-
Create an API key. In the sidebar open Links,
open your link, then open the API or Webhook tab and find
API access for this link. Click Generate key and copy it — it is shown only once.
Send it as
Authorization: Bearer <key>. - Manage keys. Open API in the sidebar to review or revoke tokens.
- Forgot your password? On the login page click Forgot password, enter your email, then the emailed code, and set a new password.
Account#
- Open your account. Click My account at the bottom of the sidebar (or your avatar in the top bar).
- Update your profile. Edit your name and click Save profile. To change your email, click Change email and enter the code sent to the new address.
- Change your password. Use Update password (or Set password if you signed up with Google). Confirm the code sent to your email.
- Sign-in methods. Link or unlink Google in the Sign-in methods section.
- Check your plan. The Subscription and Usage sections show your current package, messages used and API tokens.
Plans#
- Open Packages in the sidebar.
- Choose Monthly or Yearly, and pick your currency (e.g. KES) if offered.
- Pick a package card and click Start free trial or Continue to check out.
- The same page shows your current package, message usage and the links included.
Subscriptions#
Links#
- Open Links in the sidebar.
- Click + Create link.
- Enter the WhatsApp number, optionally adjust Account protection and Enable Webhook Notifications, then click Create & Connect Link.
- The link page opens with tabs: Connection, Credentials, Messages, API, Webhook and Docs.
- Use Rotate URL, End link or Delete link on the link page when needed. The Credentials tab shows the link ID (and API URL) you use in your system.
WhatsApp connection#
- Open your link and go to the Connection tab.
- Click Generate QR Code.
- On your phone open WhatsApp → Settings → Linked devices → Link a device, then scan the QR code.
- Wait until the link shows Connected / Active. You can now send and receive messages.
- Click Disconnect to unlink the device.
Messages#
- Make sure the link is connected (Connection tab shows Active).
- Open the Messages tab to see incoming and outgoing messages and their status.
- Use Refresh to reload and Reveal contacts to show phone numbers.
- To send from your own system, copy the API key (Auth steps) and the link ID from the API tab, then call the send endpoint shown there.
-
Send media as base64 JSON to
/whatsapp/images(JPEG, PNG or WebP, max 5 MB),/whatsapp/videos(MP4 or 3GP, max 16 MB), or/whatsapp/documents(PDF, max 5 MB). Includefilename,mime_type, and an optionalcaption. -
Send audio or voice notes to
/whatsapp/audio(base64, max 16 MB, setvoice_note: truefor a voice note), stickers to/whatsapp/stickers(WebP, max 1 MB), contact cards to/whatsapp/contacts, locations to/whatsapp/locations, and polls to/whatsapp/polls. Send a video withgif: trueto deliver it as a GIF. Addreply_toto text and media sends to quote an earlier message. -
Send a view-once message to
/whatsapp/view-oncewithtypeset toimage,videooraudio, plusfilename,mime_type,dataand an optionalcaption. The recipient can open the media only once. -
Message operations:
POST /whatsapp/reactions(send an emoji, or an empty one to remove it),POST /whatsapp/messages/{wa_message_id}/edit,DELETE /whatsapp/messages/{wa_message_id}(revoke for everyone),POST /whatsapp/messages/read, andPOST /whatsapp/typing//whatsapp/presence. These operations do not consume the message allowance. -
Groups: list with
GET /whatsapp/groups, create withPOST /whatsapp/groups, and read withGET /whatsapp/groups/{jid}. List participants withGET /whatsapp/groups/{jid}/participants, add or remove them with/participants/addand/participants/remove, or usePOST /whatsapp/groups/{jid}/participantswithactionset toadd,remove,promoteordemote. Read the profile picture withGET /whatsapp/groups/{jid}/picture, update the subject, description, announce or restrict settings withPUT /whatsapp/groups/{jid}/settings, and leave withPOST /whatsapp/groups/{jid}/leave. Get the invite link withGET /whatsapp/groups/{jid}/invite-link. Reset it withPOST /whatsapp/groups/{jid}/reset, which revokes the current link so existing links stop working (it does not clear encryption keys); inspect or accept an invite code withGET /whatsapp/groups/invite/{code}andPOST /whatsapp/groups/invite/accept. To send to a group, pass its@g.usJID astoto any send endpoint; addmentionsto a text message to notify selected members. WhatsApp only highlights a mention when the text also contains@followed by that number. Check whether numbers have WhatsApp withPOST /whatsapp/contacts/validate. -
Communities and channels: list with
GET /whatsapp/communities, create withPOST /whatsapp/communities, and read metadata withGET /whatsapp/communities/{jid}. List linked groups withGET /whatsapp/communities/{jid}/groups, link an existing group withPOST /whatsapp/communities/{jid}/groups, unlink withDELETE .../groups/{group}, and create a group inside the community withPOST .../groups/create. Update the subject or announce/restrict settings withPUT .../settings, leave withPOST .../leave, and inspect an invite withGET /whatsapp/communities/invite/{code}. Send to a community announcement group or a newsletter channel by passing its@g.usor@newsletterJID astoto any send endpoint. -
Contacts: list synced contacts with
GET /whatsapp/contacts(page withlimitandcursor; checksync.completebefore treating an empty list as "no contacts"), read one withGET /whatsapp/contacts/{contact}, and get its profile picture withGET /whatsapp/contacts/{contact}/picture. Block or unblock withPOST .../blockandPOST .../unblock, and create or update an address-book entry withPUT /whatsapp/contactsusingphoneplusfirst_name,last_nameorfull_name. Resolve LIDs withGET /whatsapp/lid-from-pn/{phone}andGET /whatsapp/pn-from-lid/{lid}. -
Incoming images, videos, audio, stickers and PDFs are relayed to your webhook as base64 in
data.media.data, with the filename, MIME type and size alongside. WaCentra Connect API keeps the file only until your endpoint accepts it or the retries run out. Then the bytes are removed and the filename, MIME type and size stay in the delivery log. Inbound files up to 16 MB are relayed. -
Base64 adds about one third to the payload. Set PHP's
post_max_sizeandupload_max_filesizeto at least24Mto send or receive 16 MB videos. - Status flow: Pending → Sent → Delivered → Read (or Failed). Messages over the rate limit are queued automatically.
-
List messages with
GET /whatsapp/messages(cursor paginated, newest first) and filter bydirection,type,status,wa_message_id,sinceanduntil. Fetch one withGET /whatsapp/messages/{wa_message_id}; the same WhatsApp id is used by edit, delete and reactions. - For testing, open Developer, turn on Sandbox mode for the link and click Test message.
Webhooks#
- Open your link and go to the Webhook tab, then click Configure webhook.
- Turn on Enable webhook and enter a public
httpspayload URL. - Choose the events to send (e.g.
messages.received) and click Save Changes. - Copy the Webhook Secret; click Rotate to replace it later.
- Incoming events are signed with
X-Webhook-Signature-V2. See Events for payloads.
Webhooks are locked while Sandbox mode is on. Turn it off on the Developer page to manage them.
© 2026 WaCentra Connect API. All rights reserved.