> ## Documentation Index
> Fetch the complete documentation index at: https://botpress.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Sunshine Conversations

{/* vale on */}

[Open in Hub](https://studio.botpress.cloud/home?exploreHub=1\&hubItemId=intver_01KMZARX5E90SJEDCQ6GKZ4ZBV)
*v2.0.1*

![](https://mintcdn.com/botpress/KbMT91f_P0tr2fc3/integrations/integration-guides/sunshine-conversations/assets/sunshine-conversations.png?fit=max\&auto=format\&n=KbMT91f_P0tr2fc3\&q=85\&s=dfc8f104f4ef889d2d46c367f23970bd)

## Prerequisites

* A [Smooch app](https://app.smooch.io) with a channel configured
* A [Botpress Cloud account](https://sso.botpress.cloud) and a [Botpress Bot](https://botpress.com/docs/get-started/quick-start.md)

## Setup in Botpress

1. Go to the [Integration Hub](https://app.botpress.cloud/hub) in Botpress Cloud (if you don't have the integration installed yet).
2. Find and open the Sunshine Conversations integration then click on the "Install to Bot" button, now go back to your bot settings.

The Sunshine Conversations integration has the following settings:

* **Enabled**: Whether Botpress will communicate with this channel
* **Webhook URL**: The URL for receiving data in Botpress
* **App ID**: The App ID of your bot in Azure
* **Key ID**: The Key ID of your bot in Azure
* **Key Secret**: The Key Secret of your bot in Azure
* **Webhook Secret**: The Webhook Secret of your bot in Azure

## Setup in Sunshine Conversations

### Smooch App

1. On the Smooch [home page](https://app.smooch.io/), click on **Create new app.**
2. Enter a name for your app and click **Create App**
3. Connect a channel to your app (Telegram, WhatsApp, or any other listed channel)
4. You should see a channel in the **Overview** section of your app

## Configuration

### App ID

The smooch channel needs the app id to identify the smooch app when making API calls

1. Go to the **Settings** section of your app
2. You should see an **App ID** section if you scroll down. Copy paste this value to the **App ID** channel configuration

### Key ID and Key Secret

The key id and secret are needed to authenticate API calls to Smooch

1. At the bottom of to the **Settings** section of your app, click **Generate API key**
2. Copy paste the id (the one that starts with `app_`) in the **Key ID** channel configuration
3. Copy paste the secret in the **Key Secret** configuration

### Webhook Secret

The webhook secret is needed to validate webhooks requests. You get a webhook secret for each webhook integration you create

1. Go to the **Integration** section of your app
2. In the **API & Webhooks** section, click on **Webhooks**
3. Click **Connect**, then **Create a webhook**
4. Paste the Webhook URL provided in Botpress
5. Select `v2` as your webhook version
6. Select **Conversation message** and **Postbacks** in the basic triggers
7. Click **Create Webhook**. You will see the webhook you created in the table, and the secret in the last column
8. Copy paste the webhook secret in the **Webhook Secret** channel configuration

### Save Configuration

Channel configuration is complete, you can now click **Save**

That's it, you may now start chatting with your bot on Sunshine Conversations!

***

## Cards

{/* vale off */}

Here's a reference for all [Cards](https://botpress.com/docs/studio/concepts/cards/introduction.md) available with the integration:

### Get or Create a Conversation

Proactively create a conversation from a bot

**input** `object`

**conversation** `object` *required*

The conversation object fields

**id** `string` *required*

The Sunshine Conversations conversation ID

**output** `object`

**conversationId** `string` *required*

The Botpress ID of the created conversation

### Get or Create a User

Proactively create a user from a bot

**input** `object`

**name** `string`

The name of the user

**pictureUrl** `string`

The URL of the user profile picture

**email** `string`

The email of the user

**user** `object` *required*

The user object fields

**id** `string` *required*

The Sunshine Conversations user ID

**output** `object`

**userId** `string` *required*

The Botpress ID of the created user


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.