Sunshine Conversations - Cognigy Documentation

Sunshine Conversations Endpoint

As of Cognigy.AI 4.97.0, the Handover Providers section in the Endpoint settings is deprecated. From Cognigy.AI 2026.4 on, the Handover Settings section in the Endpoint settings is in read-only mode. You can’t use this section to configure new handover providers. You can still view configured handover provider settings, but you can’t change them. To configure handover providers, use the Handover Providers interface, which offers greater flexibility for managing your integration with contact centers. For a smooth migration, refer to the migration guide.

The Sunshine Conversations Endpoint enables you to connect your AI Agent to the Zendesk’s Sunshine Conversations messaging platform.

Generic Endpoint Settings

Learn about the generic Endpoint settings on the following pages:

Specific Endpoint Settings

Sunshine Conversations Setup

Parameter Description
API Version The Sunshine Conversations API version Cognigy.AI uses to communicate with your app. Cognigy.AI supports version 1.1 and version 2. The version must match the one used to create the webhook in your Sunshine Conversations app.
Key ID The API key ID from your Sunshine Conversations app. The format is app_XXXXXXXXXXXXXXXXXXXXXXXX. The key ID is paired with the secret you provide.
Secret The API secret generated for your Sunshine Conversations app. This secret must match the key ID you entered earlier.
URI The base URL for your Sunshine Conversations app. For example, https://app.smooch.io. Don’t include a trailing slash (/).

How to Set Up

  1. Create a Sunshine Conversations Endpoint

  2. In the left-side menu of your Project, click Deploy > Endpoints.

    1. On the Endpoints page, click + New Endpoint.
    2. In the New Endpoint section, do the following:
      1. Select the Sunshine Conversations Endpoint type.
      2. Specify a unique name.
      3. Select a Flow from the list.
      4. In the Configuration Information section, copy the URL from the Endpoint URL field.

  3. Create a Sunshine Conversations App

  4. Go to the Sunshine Conversations Dashboard and log in with your Zendesk account.

    1. If you don’t have a workspace yet, create one first. Otherwise, select your existing workspace.
    2. Click Create App. Enter the name and description for your app. Click Create.
    3. Go to the Channels or Integrations tab. Add the messaging channels you want, for example, WhatsApp, Facebook Messenger, Slack. Follow the Sunshine Conversations instructions for each integration.
    4. Open the Settings tab of your app. Go to API Keys and click + Create new secret key.
    5. Copy the Key ID and Secret for later use in the Cognigy.AI Endpoint. Save Changes.

  5. Complete the Endpoint Configuration

  6. In the Cognigy.AI interface, open the Sunshine Conversations Endpoint you created.

    1. In the Sunshine Conversations Setup section, fill in the required fields:
      • API Version - select either v1.1 or v2, matching your Sunshine Conversations app.
      • Key ID - paste the key ID you copied from Sunshine Conversations.
      • Secret - paste the secret you copied.
      • URI - use your app’s base URI, for example, https://app.smooch.io (omit the trailing /).
    2. Save changes.

  7. Add a Webhook in Sunshine Conversations

  8. In your Sunshine Conversations app, go to Settings > Integrations > Webhooks.

    1. Click Add Webhook.
    2. Paste the Cognigy.AI Endpoint URL you copied earlier into the URL field.
    3. For Triggers, select at least the following options:
      • AppUser messages
      • Postbacks
    4. Ensure the API Version matches your Cognigy.AI Endpoint version (v1.1 or v2). Save the webhook.

More Information