8x8 Connector
Using Descope's connectors allows you to use 8x8 to send SMS messages with your own 8x8 account and trigger these actions within the authentication flow. This article will guide you through setting up and using the 8x8 connector.
Configure 8x8 connector
Descope uses your 8x8 Subaccount ID, API key, and sender details for integration.
To configure a 8x8 connector, go to the Connectors page within the Descope Console, search for 8x8, and select the connector tile.
Settings
Below is a list of applicable settings for the 8x8 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.
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.
Add your 8x8 connector to a flow
Configure 8x8 as the Default OTP Connector
To configure 8x8 as your default connector for the various OTP auth methods for SMS, navigate to OTP within Authentication Methods, and select the configured 8x8 connector. You can further configure the default OTP template for your 8x8 messages; for more details, see our guide for Using Email and SMS Templates.
Once you have configured 8x8 as the default connector within the OTP Auth method, Descope flows and any OTP calls via the API/SDK will utilize 8x8 for OTP verification.
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.
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 8x8.yarn install
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. - Message content: Enter the content of the SMS.
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.
That's it! Whenever a user goes through your authentication flow, the 8x8 connector will be automatically triggered.