Skip to main content

Smooch (Sunshine Conversations)

Requirements​

  • An HTTPS Endpoint to your chatbot:

    • Set the externalUrl field in botpress.config.json;
    • Create an HTTPS tunnel to your machine using Ngrok (tutorial);
    • Using Nginx and Let's Encrypt (tutorial).

  • A smooch.io account (you will need a business email).

Setup​

Smooch App​

  1. On the app.smooch.io home page, 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.

Botpress Connection​

  1. Go to the Settings section of your app.

  2. At the bottom, you will find an API Keys menu. Create a new API key.

  3. You will need the id (the one that starts with app) and secret key to setup your bot.

  4. Edit data/bots/<YOUR_BOT_ID>/bot.config.json.

  5. In the messaging.channels.smooch section write this configuration:

  • enabled: set to true;

  • keyId: paste the id of your key from the Settings section;

  • secret: paste the secret of your key from the Settings section.

    Your bot.config.json should look like this:

{
  // ... other data
  "messaging": {
    "channels": {
      "smooch": {
        "enabled": true,
        "keyId": "your_key_id",
        "secret": "your_secret"
      }
      // ... other channels can also be configured here
    }
  }
}
  1. Restart Botpress and test if your chatbot has been successfully connected to your desired channel.