8x8

SMS Provider

Overview

8x8 is a global cloud communications platform that provides enterprise-grade SMS and Chat messaging services. Integrating 8x8 with CleverTap allows you to send real-time marketing and transactional messages across channels using CleverTap’s unified engagement dashboard.

This integration supports HTTP-based SMS delivery, dynamic parameter mapping, and event-based message triggering.

Here’s how businesses use 8x8 with CleverTap:

  • Send OTPs and Notifications: Trigger real-time messages from mobile/web events.
  • Promote Offers and Campaigns: Reach targeted users with SMS powered by event segmentation.
  • Enhance Chat App Messaging: Expand your channel strategy with multi-mode engagement.

Prerequisites for Integration

To integrate 8x8 with CleverTap, ensure the following:

  • You must have an active 8x8 account with access to your Subaccount ID and API Key.
  • Your sender ID or virtual number must be provisioned in your 8x8 account.
  • You must have a CleverTap account with SMS setup enabled.

🚧

Support for Integration

This integration is managed and continuously improved by 8x8. The CleverTap and 8x8 integration has undergone stringent testing to ensure seamless functionality. For any questions or issues, contact 8x8 for support and resolution.

Integrate 8x8 with CleverTap

To integrate 8x8 with CleverTap, follow these three steps:

  1. Find 8x8 API Credentials
  2. Set Up CleverTap Dashboard
  3. Send a Test SMS

Find 8x8 API Credentials

To complete the setup, gather the following details from your 8x8 Customer Portal:

  • Subaccount ID: Required for the API endpoint URL.
  • API Key: Used in the Authorization header.
  • Sender ID / Virtual Number: Required as the source in the payload.

You can find all these under API Keys in your 8x8 Customer Portal Dashboard.

Set Up CleverTap Dashboard

Set up the CleverTap dashboard to connect and authenticate the 8x8 SMS provider. To configure the CleverTap dashboard:

  1. Go to Settings > Engage > Channels > SMS in the CleverTap dashboard.
  2. Click + Add Provider. The Add SMS provider page opens.
Add Provider

Add Provider

  1. Under Provider, select Other (Generic) and enter the following details:
FieldValue
NicknameEnter the nickname of the SMS provider to identify it uniquely. For example:8x8_SMS
Callback URLEnter this URL in the 8x8 platform to receive delivery status updates for your SMS messages. Refer to Set Up SMS Callbacks.
Request TypeSelect POST
HTTP EndpointPaste the URLhttps://sms.8x8.com/api/v1/subaccounts/{subAccountId}/messages/batch
Replace {subAccountId} with your actual Subaccount ID from 8x8.
Ensure that the URL is in HTTPS format, that is, your URL must begin with https://.
AuthenticationSelect No Authentication.
Provider Configuration

Provider Configuration

  1. Enter the following details under the Headers section.
KeyValue
AuthorizationBearer <API_KEY>
Content-Typeapplication/json
Set Headers

Set Headers

  1. Under Parameters, select JSON as the request type for the POST request.
    Refer to the sample payload below for the expected structure.

Sample Payload Structure (JSON):

{
  "source": "<Your Sender ID or Virtual Number>", // Must be a valid sender ID or number registered in your 8x8 account.
  "destination": "$$To",
  "text": "$$Body",
  "mid": "$$MessageID",
  "encoding": "Auto"
}
Set Parameters

Set Parameters

  1. Select the Batch checkbox and fill in the details as required.

πŸ“˜

Single Batch Limit

A single batch can have a maximum of 1,000 records.

  1. Click on Save. A pop-up box will appear, prompting you to Send Test SMS.

Send a Test SMS

Sending a test SMS helps confirm that your 8x8 integration is working before launching a live campaign. This ensures the API endpoint is correctly configured, authentication is valid, and messages can be delivered.

To validate your configuration:

  1. Click the Send Test SMS hyperlink before creating SMS campaigns and journeys.
  2. Enter the following details:
    • Country Code and Mobile Number: Enter the country code and mobile number to which you want to send the message.
    • Message: Enter sample text, such as This is a test message powered by 8x8
Send a Test SMS

Send a Test SMS

  1. Click Send Test.

If the configuration is correct, the test message will be delivered, and 8x8 will return a DLR update. If there is an error (for example, incorrect credentials or endpoint), CleverTap will display a failure notification.

Set Up SMS Callbacks

To track SMS requests, copy the Delivery report callback URL from CleverTap and share it with 8x8 support team.

  1. You can find the Delivery report callback URL on the CleverTap dashboard under the Provider
    Setup page Settings > Channels > SMS > Provider Nickname
  2. Share this URL with the 8x8 support team.
Set Up SMS Callbacks

Set Up SMS Callbacks

Verifying Successful Integration

Your integration is considered successful when the following criteria are met:

  • The test SMS is delivered to the intended mobile number.
  • You receive a DLR (Delivery Report) callback from 8x8 at the configured CleverTap callback URL, indicating delivery, failure, or queue status.
  • CleverTap logs show no errors related to authentication, payload structure, or message transmission.

Once these conditions are met, you can proceed to build and launch SMS campaigns or set up Journeys using 8x8 as your SMS provider.