What you can do:
Before you start
- A Chatbase account with an AI agent.
- A Zendesk account on a Professional Suite plan or above.
- The Zendesk ticketing integration connected on the same AI agent. Until it is, the Sunshine Connect button is disabled and shows Connect Zendesk first when you hover over it. Chatbase uses that connection to set up Sunshine in your Zendesk account.
- Zendesk Messaging not connected on this AI agent. An AI agent can use Sunshine or Zendesk Messaging, not both.
- A workspace that isn’t HIPAA-compliant. Sunshine isn’t available on HIPAA-compliant accounts.
How Sunshine differs from Zendesk Messaging
How to connect Sunshine
Create an API key in Zendesk
- Sign in to your Zendesk account as an Admin and navigate to the Admin Center.
- Navigate to Apps and integrations > APIs > Conversations API.
- Click Create API Key, enter Chatbase as the name, and press Next.
- Copy the App ID, Key ID, and Secret key displayed.

Set up the Sunshine integration in Chatbase
- Navigate to your Chatbase dashboard.
- Click the AI agent you wish to enable live chat for.
- Navigate to Integrations. Make sure Zendesk is connected before you attempt to connect Sunshine.
- Enter the copied App ID, Key ID, and Secret key, then press Submit.
Enable multi-conversations in Zendesk
- Sign in to your Zendesk account as an Admin and navigate to the Admin Center.
- Click Channels in the sidebar, then select Messaging and social > Messaging.
- At the top of the page, click Manage settings.
- Under Web Widget and Mobile SDKs, expand Multi-conversations.
- Click Set up multi-conversations.
- Click Turn on multi-conversations for your account, select the channels you want to offer multi-conversations on, then click Save.
Enable end messaging sessions in Zendesk
- Sign in to your Zendesk account as an Admin and navigate to the Admin Center.
- Click Channels in the sidebar, then select Messaging and social > Messaging.
- At the top of the page, click Manage settings.
- Under Advanced, expand Ending sessions.
- Select Agents can end messaging sessions at any time.
- Click Save settings.
Enable the Live Chat Action
- Navigate to your Chatbase dashboard.
- Choose the AI agent you integrated with Sunshine Conversations.
- Navigate to Build > Actions.
- Click Create Action, then select Sunshine live chat.
- Customize the When to use field, click Continue, then click Enable.
What happens during a handoff
- The AI agent decides the customer needs a person, based on the Action’s When to use, and collects any details checked under Collect from user.
- Chatbase opens a new Zendesk messaging conversation as the customer. Its first message contains a title, the link to the Chatbase conversation, and either a summary or the full conversation, depending on the Action’s conversation content setting.
- Your Zendesk agent replies from Zendesk. Each reply appears in the customer’s Chatbase widget with the agent’s name and avatar.
- When your agent closes the conversation in Zendesk, the Chatbase Sunshine Conversation Ended trigger ends the conversation in Chatbase.
What your Zendesk agent receives
- A title for the chat.
- The line “conversation link in Chatbase:” followed by the link to the Chatbase conversation.
- Summary: followed by an AI-written summary, or Full conversation: followed by the transcript and the customer’s attachments, when the Action is set to send the full conversation.
- The customer’s name and email, on the customer’s profile in Zendesk.
Example handoff
A customer on your Help Page writes:Customer: My account is locked and the reset email never arrives. I need to talk to someone. AI agent: I can connect you with our support team. What’s your name and email? Customer: Sam Lee, sam@example.comA new conversation opens in Zendesk with a title like “Locked account, reset email not received”, the conversation link, and a summary. Your agent replies “Hi Sam, I’ve unlocked your account.” and that message appears in the Help Page chat with the agent’s name and avatar. When the agent closes the conversation in Zendesk, the chat ends in Chatbase.
Limitations
- Sunshine requires Zendesk. The Zendesk integration must be connected in Chatbase first.
- Sunshine and Zendesk Messaging can’t share an AI agent. Disconnect one before connecting the other.
- Not available on HIPAA-compliant accounts.
- A Professional Suite plan or above is required on your Zendesk account.
- The live chat Action runs on the Chatbase widget only. It is compatible with the Chat Bubble, Center Stage, and Help Page channels only. Every other channel is incompatible and can’t be selected. See Channels for what configured, unconfigured, and incompatible mean.
Troubleshooting
Connecting shows Incorrect credentials
Connecting shows Incorrect credentials
Connecting says Zendesk Messaging is already connected
Connecting says Zendesk Messaging is already connected
Handoffs fail with a multi-conversations error
Handoffs fail with a multi-conversations error
The chat doesn't end in Chatbase when my agent finishes
The chat doesn't end in Chatbase when my agent finishes
Frequently asked questions
Do I need the Zendesk integration to use Sunshine?
Do I need the Zendesk integration to use Sunshine?
Where does the customer see the Zendesk agent's replies?
Where does the customer see the Zendesk agent's replies?
Who ends a Sunshine conversation?
Who ends a Sunshine conversation?
Can I use Sunshine and Zendesk Messaging on the same AI agent?
Can I use Sunshine and Zendesk Messaging on the same AI agent?
Which channels support Sunshine live chat?
Which channels support Sunshine live chat?
Why do I need multi-conversations in Zendesk?
Why do I need multi-conversations in Zendesk?