Set Up a Website Widget

Drop a feedback widget onto your site and control exactly where, when, and how it shows up.

Before you begin

A website widget (called an "Online" Touchpoint in the admin panel) embeds a feedback survey directly on your web pages. Add it inside a Website, then assign a Widget Stream to it.

Tip:

Test on mobile too. Over half of website visitors are on phones — make sure your widget looks great and works smoothly on smaller screens before going live.

Add a Widget

Head to Admin > Touchpoints in the sidebar. Open your Website for editing and go to Step 2 — Touchpoints. In the Online Touchpoints table, click Add touchpoint.

  1. Subscription ID — Paste the ID provided by your Ombea account manager. The system determines whether the widget is Automatic (appears on its own) or Manual (triggered by JavaScript).
  2. Widget name — Give it a descriptive name (e.g. "Support pages").
  3. Choose where to display — Select a targeting mode (see below).
  4. Choose when to show — Select a trigger (see below).
  5. Choose the position — Where the widget sits on screen. Default: Bottom right. Options: Top left, Top right, Bottom right, Bottom left, Center, Manually.
  6. Select language mode — Pick Stream language (default), Browser language, or choose a specific language. See Set Your Survey Language for details.
  7. Design tab — Customize colors, fonts, and smiley face colors. See Change Colors, Fonts & Design for the full guide.
  8. Click Add.

Nothing is saved until you click Save on the Website wizard.

ModeWhat it does
On all pagesThe widget appears on every page. This is the default.
On some pagesSpecify which URL paths to include or exclude. This is a premium feature.
Using JavaScriptTrigger the widget from your own code by calling window.oiwidgets.show('{WIDGET_ID}'). This is a premium feature.

If a premium option is grayed out, hover over it for upgrade details.

TriggerWhat it does
DirectlyAppears as soon as the page loads. This is the default.
After loadAppears after a configurable delay.
After the respondent has been inactiveAppears after a period of idle time.
What you want to changeWhere to do it
Questions, logic, block orderIn the Stream — see Set Up a Website Widget Survey
Widget colors, font, smiley facesIn the Design tab — see Change Colors, Fonts & Design
Where and when the widget appearsHere — the targeting and trigger settings above
Survey languageSee Set Your Survey Language

You can pre-fill respondent information by passing a context object when initializing the widget or triggering it manually.

Pass context in the init() call (applies to all widgets on the page):

oiwidgets.init('WEBSITE_ID', 'HOST_URL', { email: 'anna@example.com', cid: 'MEMBER-4521' });

Or pass context when triggering a manual widget (merged with any context from init()):

oiwidgets.show('WIDGET_ID', { email: 'anna@example.com' });

Here are the supported fields:

FieldWhat it does
first_nameFirst name of the respondent
last_nameLast name of the respondent
emailEmail address
phonePhone number
cidCustom identifier

How this connects to survey quota: If your Stream has a quota rule (e.g. "one response per person"), the email, phone, and cid values are used to identify returning respondents. See Limit How Often Someone Can Respond.

Good to Know

When you add a widget or change its settings, it can take up to 20 minutes for the update to appear on your site.

Click the delete icon on the widget row. A confirmation dialog warns that all associated results will be removed. The deletion stays local until you save the Website wizard.

Was this helpful?