GTM.ai
Sign up
Docs menu

How to build and publish a widget in GTM One

Learn how to describe a widget in chat, preview it on real records, and publish it to profile pages.

Scott SirowyScott SirowySenior Director, Product Management

Learn how to describe a widget in chat, preview it on real records, and publish it to profile pages.

Overview

A widget is a focused component that works on one kind of record: a company, a contact, or an opportunity. Unlike a GTM App, a widget does not run on an Audience and has no page of its own. People see it inside the profile layouts it is added to. You build a widget the same way you build a GTM App, by describing what you want in a chat.

You can duplicate a published widget to make your own copy (see How to duplicate a widget in GTM One).

A widget can look up related records from the record it is built on. For example, a company widget can show that company's contacts and deals, and a contact widget can show the contact's employer.

Build a widget

  1. In the left navigation panel, click Apps.
  2. Click Create in the top-right corner of the page.
  3. Under "WHAT ARE YOU BUILDING?", click Widget.
  4. In the "Choose a widget type to build" dialog, click Company, Contact, or Opportunity. A widget's type is fixed once it is created.
  5. In the builder, type a description of what the widget should show in the chat box and send it.
  6. Keep refining the widget through chat until it works the way you want.

Before the widget is first built, you can use the Type control at the top of the builder to start over on a different type. Once the build has started, the type is fixed: to use a different type, create a new widget. GTM One asks "Start over on a different type?" because switching starts a fresh widget and the conversation so far goes with the old one. Click Switch type to continue or Keep building to stay.

If you leave before the widget has been built, GTM One warns "Hold on, you're in the middle of something". Click Keep building to stay or Leave anyway to lose the conversation and setup.

Preview the widget on a real record

  1. In the builder, find the Preview as control beside the preview, or in the slim row above the preview when the builder shows one pane at a time.
  2. Click it and search for a company, a person, or an opportunity. Type at least three characters to search.
  3. Click the record you want. The preview shows the widget for that record.

The control starts on the record you last tested for that widget type, and lists recent choices under "Recently tested". The preview re-renders against whatever you pick. Nothing is saved or changed on the record.

A widget needs a record to show anything, so its thumbnail is taken from one. When your widget has no thumbnail record yet, the first record you pick in Preview as becomes the record GTM One uses for its thumbnail. If the widget has already been built and has no thumbnail, GTM One takes the thumbnail screenshot right away from that record. If the widget is still being built, GTM One takes it when the build finishes. A widget that already has a thumbnail keeps it. Clearing your Preview as choices does not set a thumbnail record. To change the thumbnail later, see How to change a GTM App's thumbnail and description in GTM One.

Set the widget's height

  1. In the builder, open the HEIGHT control in the slim row above the widget preview.
  2. Click Auto to let the widget grow with its content, up to 820 pixels.
  3. Or click Compact (240 pixels, for a score, a few facts and one call to action), Standard (420 pixels, for a short feed or list), or Tall (620 pixels, for dense detail across several sections).
  4. Or click Custom and type a height from 160 to 820 pixels.

Publish the widget

  1. Click Publish in the top-right corner of the builder.
  2. Click Publish widget to confirm.
  3. When the widget is live, use the rows on the "<widget name> is live" screen to name and describe it, choose a thumbnail, share it, or embed it.

A published widget starts private to you. For naming, thumbnails, and what the live screen offers, see How to publish a GTM App in GTM One and finish setting it up.

Add the widget to a profile layout

  1. On the live screen, click Embed it on a company profile. For a contact or opportunity widget, the row opens the matching layout.
  2. In the layout editor, find the widget in the Section Library and add it to a tab.
  3. Click Save layout.

Republish anytime. Every page the widget is embedded in picks up the change.

Share the widget

Share a published widget so teammates can add it to their own profile layouts. Click Share with your team on the live screen, or follow How to share a GTM App or widget in GTM One. Recipients receive an email saying they can embed it when they personalize their layouts.

If you see an error

  • "Couldn't start this widget" followed by "The widget could not be created. Try again." The widget was not created. Click Try again.
  • "This widget is not available yet" followed by "Check back once its owner has published it." You opened a widget its owner has not published. Ask the owner to publish it.
  • "Entity search for this type is coming soon". The Preview as search is not available for that type yet. Build the widget without a record preview and check it after publishing.

Resources