Widget Embed Code

Copy and configure the script tag for your website.

Copy the Embed Code

After creating your widget, you will find it in the widget overview. To add it to your website, open the widget and copy the code snippet from the Widget Integration Script section. Paste this script into the HTML code of your website - the widget will then appear on the target page and visitors can start using it immediately.

The generated <script> tag includes attributes for your saved settings. If needed, you can override these directly in the HTML. All attributes use the data- prefix so they pass through CMS HTML sanitisers (TYPO3, WordPress, etc.) unchanged. The legacy non-prefixed names (e.g. token, lang) are still accepted, so existing embeds keep working.

Attribute

Description

Example

data-token

Widget access token (required)

data-token="abc123"

data-lang

Interface language (en or de)

data-lang="de"

data-hide-activator-button

Hide the floating button (use the JS API to open the widget)

data-hide-activator-button="true"

data-button-position

Corner placement: bottom-right or bottom-left

data-button-position="bottom-left"

data-button-offset

Pixel offsets as JSON

data-button-offset='{"bottom":40,"right":24}'

💡

Use the Test Widget button to open a preview of your widget without embedding it on an external page.

JS API

You can control the widget programmatically using the global window.RespeakWidget object:

  • window.RespeakWidget.open(callback) - Opens the widget. The optional callback function is called once the widget has opened.

  • window.RespeakWidget.close() - Closes the widget.

â„č

The JS API is especially useful when data-hide-activator-button="true" is set - for example, to trigger the widget from your own button or link.

PreviousCustomize Your WidgetStyle colors, logos, button position, and security options.NextWorkspace ManagementManage users, roles, notifications, API keys, and analytics.