Documentation.

Quick Start

Three steps are all it takes to get started with Cxperium. We manage your WhatsApp Business API application on your behalf.

1. Create your account

   After your demo request, our team sets up your account and submits your WhatsApp Business API application to Meta. Approval is usually completed the same day.

2. Verify your number and profile

   Once your business number is approved, you edit your brand profile (logo, description, working hours) from the dashboard. The green verification badge application is also submitted here.

3. Send your first message

   Create a template, submit it for approval and launch your first campaign — or pick one from the ready-made template library. You can do it all from the dashboard without writing any code.

Platform Modules

Detailed user guides for every module on the dashboard, plus developer references. Step-by-step walkthroughs for each module are also available in the in-app help center.

Web & Mobile Channels

Same bot, same inbox: alongside WhatsApp, add a chat bubble to your website or connect your own mobile app. When you create a channel under Channels → Add in the dashboard, you receive a channel key and a secret.

For a web channel, all you need to do is paste the install code provided by the dashboard right before your site's </body> tag. Colours, position and texts are changed in the dashboard's Widget Designer, after which you copy the code again.

<!-- Cxperium chat -->
<script>
  window.cxperiumSettings = {
    channelKey: "ch_xxxxxxxxxxxxxxxx",
    secret: "…",
    brand: "Acme Support",
    color: "#7c3aed"
  };
  (function (d) {
    var s = d.createElement("script");
    s.src = "https://cdn.cxperium.com/widget/v1/cxperium-widget.js";
    s.async = true;
    d.head.appendChild(s);
  })(document);
</script>

For mobile apps (iOS, Android, React Native, Flutter) the custom channel works over REST + WebSocket: the app registers once to obtain an identity and a token, then sends messages over WebSocket and receives replies instantly. No server is required; if you prefer, you can also connect through your own server with signed requests.

Setup steps, all widget settings, message types and error codes are in the Channels guide.

API for Developers

Connect contact management, message and notification sending, surveys, tickets and live chat to your own systems with the Cxperium REST API. All requests go to https://api.cxperium.com over HTTPS and are authenticated with the apikey header. You create your API key in the dashboard under Settings → API Integration (available on Premium and Enterprise plans).

# Create a contact (updates the existing one if the phone number exists)
curl -X POST https://api.cxperium.com/api/contacts \
  -H "apikey: $CX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "905551112233",
    "userProfileName": "Jane Doe",
    "email": "jane@example.com",
    "language": "EN",
    "tags": []
  }'

# Free-form text to a contact with an open session (wrote to you in the last 24 hours)
curl -X POST https://api.cxperium.com/api/send-message \
  -H "apikey: $CX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "type": "TEXT", "phone": "905551112233", "text": "Hi! Your order has been shipped." }'

# 201 Created
{ "status": 201, "success": true, "message": "OK", "data": { … } }

Every response carries status, success, message and, where applicable, data. An invalid or missing key returns 401 with { "error": "Invalid API key!" }. To reach contacts whose session window is closed, send a notification with an approved template via POST /api/notification/send-single. There is a limit of 100 requests per minute per IP; beyond it you receive 429.

All endpoints, pagination and filter rules, sample bodies: REST API Reference. The Postman collection can be downloaded from the View Collection button on the API Integration screen in the dashboard.

Webhooks

When survey answers, ticket and chat events, bulk sending summaries or assistant events occur, Cxperium sends a JSON POST request to the HTTPS address you define in the dashboard. Webhooks are available on the Enterprise plan; you choose which events are sent and which surveys are covered in the webhook definition.

# COMPLETED — when a contact finishes a survey
{
  "event_status": "COMPLETED",
  "survey": { "id": "6650aabbccddeeff00112233", "name": "Customer Satisfaction Survey" },
  "contact": { "contactId": "6612cc33dd44ee55ff667788", "name": "J*** D**", "phone": "905321112233" },
  "questions": [
    { "id": "6650bbccddeeff0011223345", "name": { "EN": "How would you rate our service from 1 to 5?" }, "answer": { "button_reply": "5" } },
    { "id": "6650bbccddeeff0011223346", "name": { "EN": "Anything you would like to add?" }, "answer": { "text_reply": "Very satisfied." } }
  ],
  "start_time": "2026-09-07T09:47:40.000Z",
  "complated_time": "2026-09-07T09:47:40.212Z"
}

Every request contains the event code event_status and the sending time complated_time; the remaining fields are event-specific. Responding with 2xx is enough; the body is not read. The request is retried once only on a network error; 4xx/5xx responses are not retried. Fields without a value are omitted from the JSON.

All events and field descriptions: Webhook Reference. Steps for defining one in the dashboard: Webhook Integration.