Build with Lynkist
Programmatic access to WhatsApp Business, templates, campaigns, and conversations.
Welcome to the Lynkist Developer Hub. Six resources — contacts, templates, messages, media, campaigns and webhook endpoints — are exposed over REST, with signed webhooks across 24 event types so your systems hear about what happens in between.
Start here
Quickstart
Connect a WABA, generate an API key, and send your first template message end-to-end.
API Reference
Conventions for the JSON surface — base URL, pagination, idempotency, request IDs.
Authentication
Key format, the 12 scopes, the 4 presets, IP allowlists, and rotation.
Webhooks
The 24-event catalog, signed delivery contract, retry curve, and verification recipe.
Rate Limits
Per-plan quotas, response headers, and 429 backoff guidance.
Errors
Response envelope, HTTP status codes, and the headers you should log.
Resources
Each per-resource page documents every endpoint with copy-paste curl examples, request/response shapes, and the webhook events it emits.
Contacts
List, search, create, bulk-import, update and archive contacts.
Templates
Draft, submit to Meta, and list approved WhatsApp templates.
Messages
Send pre-approved template messages through your tenant's WABA.
Media
Direct upload for message media; resumable session for template media.
Campaigns
Bulk template sends — audience, lifecycle, analytics, errors.
Webhook management
Create endpoints, rotate secrets, inspect deliveries, retry failures.
What you can build
- Transactional notifications — order confirmations, OTPs, shipping updates, appointment reminders.
- Outbound campaigns — segmented bulk sends using approved WhatsApp templates.
- Two-way conversations — receive inbound messages via webhook (today); reply via API (roadmap). The shared inbox itself has no API surface yet.
- CRM and store integrations — sync contacts and trigger template sends from your own payment or signup events.
Conventions
- Base URL:
https://lynkist.io/api/v1/public - All requests authenticate with a
Bearer lk_sk_{env}_…token (see Authentication). - Responses are JSON. Successful calls return the resource directly; errors return
{ "success": false, "error": { "code", "message" }, "meta": … }(see Errors). - Webhook payloads are HMAC-SHA256 signed over
{timestamp}.{body}— verify before trusting (see Webhooks).
This Developer Hub is comprehensive as of 2026-06-01. See Changelog for everything that has shipped or is on the roadmap.