ConnectStream Innovation Lab LLC Logo ConnectStream Innovation Lab  LLC
Developer Hub

Platform Documentation

Integrate ConnectStream's robust WhatsApp automation API and real-time webhook streaming engine.

1. Getting Started

Integrating with ConnectStream BSP begins with connecting your Meta WABA account. Follow our step-by-step Meta Cloud API access onboarding pipeline:

Step 1: Account Verification Prerequisites

Ensure your Business Manager is verified inside Meta Business Suite. You must also have your Phone Number ready to receive SMS validation.

Step 2: Embedded Opt-In Toggle Placement

To initiate conversations, embed our active WhatsApp opt-in toggle on target web pages. This collects customer consent cleanly and maps directly to your CRM profile:

<div class="connectstream-optin-toggle" data-waba-id="YOUR_WABA_ID"></div>
<script src="https://sdk.connectstream.com/v1/optin.js" async></script>

2. API Reference

Trigger Template Messages, custom media-rich attachments, and dynamic interactive button matrices directly with our payload builder APIs:

Send Interactive Quick-Reply Payload

POST https://api.connectstream.com/v1/messages/send
Content-Type: application/json
Authorization: Bearer ZAP_LIVE_TOKEN_129841

{
  "to": "+1234567890",
  "type": "interactive",
  "interactive": {
    "type": "button",
    "header": {
      "type": "text",
      "text": "Apex Properties Walkthrough"
    },
    "body": {
      "text": "Hi Sarah! Please confirm your physical property tour on Saturday at 2:00 PM."
    },
    "action": {
      "buttons": [
        {
          "type": "reply",
          "reply": {
            "id": "confirm_booking_yes",
            "title": "Confirm Tour"
          }
        },
        {
          "type": "reply",
          "reply": {
            "id": "confirm_booking_no",
            "title": "Reschedule"
          }
        }
      ]
    }
  }
}

3. Webhook Mapping Pipelines

ConnectStream handles real-time event routing loops natively. Configure a listening port endpoint in your workspace panel to capture inbound statuses and messages:

Supported Event Triggers

  • message.sent: Fired when Meta accepts outbound message parameters.
  • message.delivered: Confirms delivery to recipient user phone device.
  • message.read: Fired when recipient opens message thread.

Automatic Failover Retry Policy

If your listener server experiences connection hiccups, our system initiates exponential backoff retries (up to 5 attempts) over a 24-hour window to safeguard data stream logs.

4. Automation Workflows Canvas

Create routing paths using custom conditional rules to assign conversational control loops between AI chatbots and human support representatives:

Structural Control Loop Rules

Rule 1 Inbound text triggers LLM Intent mapping index.
Rule 2 If Intent equals KYC_FILE_UPLOAD, route path to document validation queue chatbot.
Rule 3 If user replies TALK_TO_AGENT, instantly transfer session control to active Team Inbox queues.

Ready to get started?

Join 12,500+ businesses growing with ConnectStream.

Start free → Talk to sales