Sunshine Conversations: Deploy an Endpoint

Within our Cognigy.AI platform you're able to connect your Cognigy resources to your Sunshine Conversations application by using our Sunshine Conversations Endpoint integration.

Deploy a Sunshine Conversations Endpoint

With the implementation of a Sunshine Conversations Endpoint you can easily connect your Sunshine Conversations application with Cognigy.AI.

This How-to covers the necessary steps for creating and connecting a Sunshine Conversations Endpoint. If you want to get information about assigning a Flow to the Endpoint and setting up the Data Management see Endpoints.

Two Step Preparation Process

1 Configure Your Sunshine Conversations App for the usage of the Cognigy Endpoint on Sunshine Conversations API
2 Creation and configuration of the Sunshine Conversations Endpoint within Cognigy.AI

1 Configure Your Sunshine Conversations App

🔗 On Sunshine Conversations API

*Requirements**
✔ Sunshine Conversations Login
✔ A Sunshine Conversations Workspace

1.1 Create a Sunshine Conversations App

Create a Sunshine Conversations App for your Sunshine Conversations Workspace (see figure 1.1).

Figure 1.1: Create a Sunshine Conversations App

1.2 Connect to channels and integrations

Each Sunshine Conversations app can be configured with a collection of messaging channels like Facebook Messenger, WhatsApp or Slack. In addition to configuring messaging channels using the Sunshine Conversations dashboard, Sunshine Conversations also provides APIs to configure integrations programmatically. This is particularly useful when offering Sunshine Conversations messaging capabilities as a part of your own software product.

Go to the integration tab, select and configure your integration following the instructions. You can see how it's done here: Sunshine Conversations channels (see figure 1.2).

Figure 1.2: Connect with messaging channels

1.3 Get the Key ID and Secret for verification

To successfully connect your Sunshine Conversations App with the Cognigy.AI Endpoint you'll need the Key ID and Secret of your Sunshine Conversations App. Go to the Settings tab of your Sunshine Conversations App and go to the API keys section, press + Create new secret key and you will get a Key ID and a Secret. Copy and save them. Click on Save Changes.

2 Creation and configuration of the Sunshine Conversations Endpoint

🔗 On Cognigy.AI

Requirements
✔ Key ID
✔ Secret

2.1 Create a Sunshine Conversations Endpoint

First you have to create an Endpoint of the type Sunshine Conversations (see figure 2.1). To do this, navigate to the Endpoints menu, found under the Deploy sub-menu in the resources panel on the left of the interface. Click +New Endpoint button at the top of the screen and select Sunshine Conversations from the list of available endpoint types.

Figure 2.1: Create a Sunshine Conversations Endpoint

2.2 Configure the Sunshine Conversations Endpoint

Expand the Sunshine Conversations Setup panel (see figure 2.2) and paste the saved API Key ID and Secret (step 1.3) into the corresponding fields. In the URI field, just copy the base URL from your Sunshine Conversations App, depending which one you are using. It can differ from USA or EU, just look at the URL in your browser, e. g. "https://app.smooch.io". 

The version of the API will depend on how you set up the webhook integration for Cognigy.AI within the Sunshine Conversations app in a later step. Cognigy.AI supports both the v1.1 and v2 API.

Figure 2.2: Endpoint Configuration - Sunshine Conversations Setup

2.3 Get the Endpoint URL

Move to the top of the Endpoint Configuration page and copy the Endpoint URL which is displayed above the General Settings (see figure 2.3).

Figure 2.3: Finding the Endpoint URL of a Sunshine Conversations Endpoint

Final Step: Connect Your Sunshine Conversations App to the Endpoint

Create Webhook

Requirements
✔ Endpoint URL

In order to connect your Sunshine Conversations App to Cognigy.AI, you will need to add a Webhook in your integrations. The Webhook will be the bridge between Sunshine Conversations and Cognigy.AI. You can create a Webhook in the integrations tab (see figure 2.3 and 2.4).

Figure 2.3: Add Webhook

Figure 2.4: Webhook integration

Create a Webhook, you will be asked to fill in a URL. Here you have to paste the Endpoint URL. There are also some trigger options that you can use. For now, only AppUser messages and Postbacks are required (see figure 2.5). When selecting the API version, ensure you select the matching version in the Endpoint settings within the Cognigy.AI endpoint.

Figure 2.5: Webhook configuration

Create the Webhook and you will see a notification about the connection status on top of the page.

You should be all set up to use the Sunshine Conversations Endpoint you've created with a Flow of your choice.