Skip to main content
All CollectionsBuilding ExperiencesCompanion
Getting Started with Companion
Getting Started with Companion
Updated over a week ago

A Jebbit Companion is a widget that you can add to your website. Companions are a great way to capture declared data directly onsite, or to help visitors navigate your website, or engage site visitors through real-time personalization, and all of the above!


Building a Companion

  1. To start building out a Companion, navigate to the Template Gallery and look for the group of Companion templates.

  2. Hover your mouse over the Companion Template that you want to use as a starting off point, and click on "Use Template." This step will prompt you to name your Companion and select a Style Guide, and then you will be brought to the Builder Map.

    From the Builder Map, you can add screens, create pathways, and design your experience just as you would for any standard or immersive Jebbit experience.

  3. As you design your Companion unit, keep in mind that the size of the screen is small. For that reason, you should design your Companion as if you are optimizing the experience for mobile. Smaller font sizes, and arranging buttons into columns is a great way to optimize the content and make it easier to engage with your experience.

  4. Throughout the design process, use the Preview feature to get a sense of what your Companion unit will look like onsite.

  5. When you're happy with the look and feel of your Companion, then you can publish and move onto the configuring your launch setting from the Launch page!

Capturing a UID with Companion

Lightbox and Companion deployments differ from standard Jebbit deployments because they are launched via JavaScript on your site, whereas standard experiences are launched via a direct URL or a URL embedded in an iframe. For that reason, capturing a UID with a Lightbox or Companion deployment requires a slightly different setup than capturing a UID via URL for standard experiences.

  1. Place the Global Snippet Code on your site as you normally would. Review instructions for launching Lightbox or Companion as needed prior to this step.

  2. Add an additional line of JavaScript right below the Global Snippet Code on your site. This is the JavaScript that you need to add:

    window.JebbitObject.userId = 'camel-penguin-crocodile-mouse';
  3. Replace 'camel-penguin-crocodile-mouse' with the actual tag that will allow you to dynamically capture a UID for known users. What you place here will be determined by your team.

Frequently Asked Questions

Q: Can I take an existing experience from my workbench and convert it into a Companion experience?
A: Yes! You can convert any standard or immersive experience into a Companion or Lightbox experience by making a copy and changing the experience type when you do. Just keep in mind, you will want to make sure that your design copy is optimized for a smaller screen if you convert a full size experience into a Companion or Lightbox.

Q: Can I allow users to skip the Lead Form if we have captured their UID?

A: Currently, there is no way to allow users to skip a Lead Form, even if you have a UID captured for their session. This is specific to Lightbox and Companion deployments only as you are able to set your experience up this way when you launch a standard experience.

If you intend to target known and unknown users with your Lightbox or Companion deployment, then you should add a Lead Capture screen to your experience because it will be shown to all traffic. If you intend to only target known users, then a Lead Form won't be necessary as long as you are capturing UIDs.

Did this answer your question?