8x8 Connector
Descope’s 8x8 connectors let you use your own 8x8 account to send messages via SMS, Viber, or WhatsApp directly within your authentication flows. This guide walks you through configuring and using each of the available 8x8 connectors.
Configuration
To configure any of the 8x8 connectors, go to the Connectors page within the Descope Console, search for 8x8, and select the connector tile that matches your use case.
Below are lists of applicable settings for each of the 8x8 messaging connectors:
8x8 for SMS Connector
- Connector Name: Custom name for your connector. This will come in handy when creating multiple connectors from the same connector template.
- Connector Description: Describe what your connector is used for.
- Subaccount ID: 8x8 Subaccount ID. To obtain this, go to the 8x8 Connect Portal / API Keys.
- API Key: 8x8 API Key. To obtain this, go to the 8x8 Connect Portal / API Keys.
- Source: (Optional) The Sender name (SenderId) from which the SMS is going to be sent.
- Country: (Optional) The country code of Destination number. See 8x8 documentation for more details.
- Phone Number: Use this number for testing.
8x8 for WhatsApp Connector
- Connector Name: Custom name for your connector. This will come in handy when creating multiple connectors from the same connector template.
- Connector Description: Describe what your connector is used for.
- Subaccount ID: 8x8 Subaccount ID. To obtain this, go to the 8x8 Connect Portal / API Keys.
- API Key: 8x8 API Key. To obtain this, go to the 8x8 Connect Portal / API Keys.
- Template ID: 8x8 template ID for a WhatsApp message. These are managed in your 8x8 dashboard. Read more on templates here.
- Country: (Optional) The country code of Destination number. See 8x8 documentation for more details.
- Use Static IPs: When enabled, the connector uses a predetermined pool of IPs from which all requests are made.
- Receiver: Use this number for testing.
8x8 for Viber Connector
- Connector Name: Custom name for your connector. This will come in handy when creating multiple connectors from the same connector template.
- Connector Description: Describe what your connector is used for.
- Subaccount ID: 8x8 Subaccount ID. To obtain this, go to the 8x8 Connect Portal / API Keys.
- API Key: 8x8 API Key. To obtain this, go to the 8x8 Connect Portal / API Keys.
- Country: (Optional) The country code of Destination number. See 8x8 documentation for more details.
- Use Static IPs: When enabled, the connector uses a predetermined pool of IPs from which all requests are made.
- Receiver: Use this number for testing.
You can test if your connector's configuration is working properly simply by hitting the Test
button and viewing the Test Results
panel.
Save your configuration by hitting Create
.
Using an 8x8 Connector in a Flow
Configuring 8x8 as the Default OTP Connector
To use 8x8 as the default connector for OTP authentication via SMS or Instant Messaging:
-
Go to Authentication Methods > OTP in the Descope Console.
-
Choose the appropriate 8x8 connector:
- Use the SMS connector for SMS-based OTP.
- Use the Viber or WhatsApp connector for Instant Messaging OTP.
You can also configure the OTP message template used with the 8x8 connector.
For more information, see our Using Email and SMS Templates guide.
Once 8x8 is set as the default connector, any OTP verification triggered through Descope Flows or via the API/SDK will automatically use 8x8 for SMS or Instant Messaging delivery.
Using 8x8 Explicitly in Flows
To override the default OTP connector within your flow to utilize 8x8, navigate to
Flows and choose your flow. Once you are in the flow that you'd like to use 8x8, select
and edit the action that starts the OTP process, such as Sign In, Sign Up, or Sign Up or In with OTP via SMS. If you have not yet added the OTP action, you can do so by clicking the blue +
icon at the top left, searching and
selecting the OTP action, and then selecting and editing the initiating action.
In this example, we will update the Sign Up or In / OTP / SMS
action to utilize the 8x8 connector and override the
configured default for the OTP auth method. For the 8x8 for Viber or WhatsApp connectors, the Sign Up or In / OTP / Instant Messaging (IM)
should be used.
Once in edit mode for the initiating OTP action, select the dropdown for the connector and choose your 8x8 connector. After selecting the 8x8 connector, click done, and save your flow. You can also select a customized template; for more details, see our guide for Using Email and SMS Templates. This action within your flow will utilize the 8x8 connector and override the configured default OTP connector.
Sending Custom Messages via 8x8 in Flows
There may be a use case where you want to send a text message as part of your Descope flow that is not directly related to the OTP Auth flow; this section will describe how to use 8x8 to send custom messages.
Navigate to: Flows, choose your flow. Then, tap the create button
(designated via the +
icon), select Connector, and choose the 8x8 connector action that matches your use case.
Click to set down the connector in your flow editor and double click the action to add required fields:
- To: Who the message should be sent to. Setting this dynamically based on previous attributes is recommended (eg.
{{user.phone}}
). As you type in the input field, options appear. - Connector: Specify which connector should be used if multiple of one type of 8x8 connector exists in the project.
- Message content: Enter the content of the message.
Template ID
.Now, link your connector at a logical point in your authentication flow, likely at the end of the flow after the phone number has been submitted by the user.
Once you've completed these steps, whenever a user goes through your authentication flow, the 8x8 connector will be automatically triggered in your flow.