Widget
Get Zendesk Chat Page
Serve a standalone HTML page with embedded Zendesk Web Widget.
This endpoint serves a dedicated chat page that loads the Zendesk Messaging widget. It's designed to be used as a link for human handoff from the MultiLayer LLM chatbot.
The page automatically opens the Zendesk chat widget when loaded.
If a JWT token is provided (via query parameter), the user will be authenticated in the widget and will see the same conversation where the chat history was sent by the Sunshine Conversations API.
Usage:
- Direct link: https://api.yourserver.com/widget/{assistant_uuid}/zendesk-chat
- With auth: https://api.yourserver.com/widget/{assistant_uuid}/zendesk-chat?token={jwt}
- Use this URL when transferring users to human support from the bot
Query Parameters:
- token: JWT token for user authentication (optional, generated by Sunshine API)
Requirements:
- The assistant must be configured with mode='zendesk'
- The zendesk_snippet_key must be set (obtained from Zendesk Admin Center)
- For history sync: zendesk_app_id, zendesk_key_id, zendesk_secret_key (optional: zendesk_signing_key_id + zendesk_signing_secret — Messaging signing key)
get/widget/{uuid}/zendesk-chat
Request
- Base URL: https://api.platform.v1.aureo.io
- URL: https://api.platform.v1.aureo.io/widget/{uuid}/zendesk-chat
- Auth: none declared
Path parameters
uuidstring required
Query parameters
tokenstring
handoff_codestring
Response
Successful Response
Changes
No recorded changes to this operation across all 1 revision of this API.