Embedding

Embed webchat

Embed Antly webchat and use the public webchat bootstrap, token, send, and message controllers.

Antly webchat is a public website surface backed by omnichannel controllers. Public controller intents cover configuration, visitor token requests, token verification, sending messages, and retrieving messages.

Use the configured webchat snippet from the product when possible. It keeps tenant settings, channel availability, and branding in sync with Antly.

Embed snippet pattern

html
1<script> 2 window.AntlyWebchat = { 3 tenant: "acme", 4 launcher: "bottom-right" 5 }; 6</script> 7<script async src="https://<tenant-domain>/webchat/sdk.js"></script>

The exact SDK URL and configuration keys come from the tenant's webchat settings. Do not hard-code secrets in the page.

Public bootstrap calls

The public webchat flow uses authenticationClass: "public" and controller intents under omnichannel.Omnichannel.

json
1{ 2 "__meta__": { 3 "schema": "controller", 4 "namespace": "omnichannel.Omnichannel", 5 "intent": "get_webchat_config", 6 "authenticationClass": "public", 7 "return": { 8 "enabled": null, 9 "theme": null, 10 "welcomeMessage": null 11 } 12 }, 13 "tenant": "acme" 14}

After configuration, the client requests or verifies a visitor token, then sends and fetches messages through the webchat controllers. The controller enforces tenant webchat settings server-side.

For admin setup, see /guides/webchat and /guides/omnichannel-inbox. For anonymous access boundaries, see /developer/public-access.