Skip to main content

Embed a ChatATP agent widget

You can embed a ChatATP agent directly on a public website, documentation page, or support portal by loading the web widget runtime and passing the agent token plus the widget configuration fields you need. The widget is intentionally lightweight:

Required fields

The widget needs three things before it can render:
  • data-agent-token: the agent or deployment token exposed from the ChatATP dashboard.
  • data-api-base: the base URL for the web chat API route, usually https://chatatp-agent-builder-backend.onrender.com/dapi/web-chat.
  • data-ui-stylesheet: the stylesheet URL that applies the widget’s UI styles.

Optional fields

The full list of common fields is shown below.

Passing the authenticated identity

If your site already has a signed-in user, you can avoid showing the default onboarding form by creating a profile object ahead of the widget script:
Then set:
The widget will reuse full_name and email from that object and keep the same visitor identity attached to the browser/device metadata sent during onboarding.

Route control

Use allowed-routes and disallowed-routes to show the widget only on pages your agent should answer on.
For more advanced deployment or white-label settings, generate the embed snippet from the backend web_chat.embed payload. It exposes the same configuration shape as the static data attributes shown above.