Zendesk Sunshine

You can deploy DRUID bots across any Zendesk Sunshine-supported channels, offering greater flexibility to empower your clients and users to engage with you effectively.

Note:  Previously, Sunshine Conversations apps integration only supported bot deployment in WhatsApp. However, starting with DRUID 8.9, you can deploy bots across multiple Sunshine-supported channels, expanding your communication options.

Prerequisites

  • You have built and published a DRUID chatbot.
  • Your Zendesk subscription is either Suite Professional or Suite Enterprise, as only these plans provide access to Sunshine Conversations.
  • You have an admin account for your company's Zendesk tenant.

Deploying the bot in a Zendesk Sunshine-supported channel

To deploy the bot in a Zendesk Sunshine-supported channel, follow these steps:

Step 1. Create Conversations API

Log into your Zendesk tenant using an admin account and go to Admin Center.

In the left menu, click Apps and integrations, and under APIs, select Conversations API.

Click the Create API key button. Follow the wizard instructions to create a Conversations API and save it.

Click the actions button inline with your conversations API and select View details.

The API details appear.

Copy the credentials as you will need to configure the Zendesk Sunshine channel in DRUID.

Step 2. Create webhook

In the left menu, click Apps and integrations, and under Integrations, select Conversations integrations.

Click the Create integration button. The integration creation page appears.

Give the integration a name to help identify it.

In the Webhook endpoint URL, enter the WebhookInboundURL you take from the DRUID Portal, bot channel Sunshine Platform (by Zendesk).

Select what to include in the webhook payloads.

Select the following webhook subscription:

  • Conversation created
  • Conversation message
  • Switchboard pass control
  • Switchboard pass control failure
  • Switchboard accept control
  • Switchboard accept control failure
  • Switchboard offer control
  • Switchboard offer control failure
  • Delivery failure
  • Participant joined conversation
  • Participant left conversation

Save the webhook. It will now appear on the Conversations Integrations page. Next, retrieve the webhook secret, as you’ll need it to configure the channel in the DRUID Portal.

Click the actions button inline with your webhook integration and select View details.

Copy the Shared secret that is the Webhook Secret you will configure in DRUID.

Step 3. Activate the Sunshine Platform (By Zendesk) channel in Druid

  1. In DRUID Portal, go to the bot Channels, then click Sunshine Platform (by Zendesk). The channel section expands.
  2. Enter the App ID, API Key Id and API Key Secret you copied from your Conversations API details in Zendesk.
  3. In the Webhook Secret field, enter the Shared secret you copied from the webhook integration details in Zendesk.
  4. In the Sunshine URL field, enter your Zendesk tenant URL adding /sc at the end: https://Zendesk_tenant/sc.

  5. Click the Publish button. The channel activation might take up to 1 minute.

After the channel’s activation, the following fields are available in DRUID:

  • [[ChatUser]].ChannelId = "zendesk"
  • [[ChatUser]].UserId - Stores the unique identifier of the Zendesk user account.

Step 4. Create Zendesk channel

This section describes how to deploy the bot in Zendesk web channel:

Log into your Zendesk tenant using an admin account and go to Admin Center.

In the left menu, click Channels, and under Messaging and social, select Messaging.

Click Add channel and select the Web Widget.

Configure the web widget based on your preferences following the on screen instructions and save it.

Click on the channel and in the channel configuration page, click on Installation and copy the widget code.

Add the Web Widget code snippet to your website by updating the HTML of every page where you want the widget to appear. Paste the code snippet right before the closing </body> tag.