Adding Pigeonhole Chat Support to a Gallery Experience

In this topic you will learn how to add Pigeonhole Chat Support to a Gallery template.

Pigeonhole can be used to easily add event based interactivity (live Q&A, chat, polls, surveys, etc.) to a Gallery Experience. Typically, a new Pigeonhole is created for the event and then sessions are created for the live events. Once the session is created, Pigeonhole embed code is pasted into the Media asset you want to put on. The embed code will cause the Pigeonhole Chat display to the player's side.

Creating a Pigeonhole event and session

You should create a new Pigeonhole for your live event and then add sessions for each video that will have Pigeonhole Chat enabled.

  1. Login to your Pigeonhole account.
  2. Click + Add Pigeonhole and click the account to use.
  3. On Event type select Virtual.
  4. Enter an Event name and Passcode.
  5. Enter Start and End dates for the event. These dates control how long the Pigeonhole will be active.
  6. Select a Timezone and Expected total participants.
  7. Click Continue.
  8. Now that the event is created, the Agenda item will be selected in the left navigation. Click Add session > Create new.
  9. Select a Session Type of Chat.
  10. Enter a Session name.
  11. Configure the Chat Settings as appropriate.
  12. Click Add Chat. Confirm the session was created.

How to setup authorization for SSO users in Pigeonhole.

If the experience uses SSO sign-in, and you want to authorize SSO users in Pigeonhole Chat, follow these steps.

    1. In Pigeonhole, click More settings in the left navigation.
    2. Select Attendees tab.
  1. In Profile Information, check Allow creating attendee profile through embed, and click Save.
  2. Scroll down to Registrant click the down-arrow and select Settings.
  3. Then check Allow adding new Registrant Profiles through embed option and click Save.
  4. Close.

Create Pigeonhole custom field

    1. On Video Cloud go to Admin section.
    2. Select Video Fields tab.
  1. On the Custom Fields section click Add Custom Field.
  2. Create the chat_embed custom field by writing Pigeonhole Chat in the Display Name field and chat_embed in the Internal Name field. The chat_embed data is used in the supported Gallery template in order to add the Pigeonhole Chat to the player's side.
  3. Click Save Field.

Adding Pigeonhole Chat to a Media asset

Adding Pigeonhole Chat to a Video Cloud Media asset is done by using the chat_embed custom field. To add Pigeonhole chat to a Media asset, follow these steps.

  1. In Pigeonhole, click Run your event and copy the link.
  2. Open the Media module.
  3. Choose the video in which you want to embed Pigeonhole Chat.
  4. On Custom fields section click Edit.
  5. Paste the Pigeonhole link in the Pigeonhole Chat field.
  6. Click Save.


  • This feature is only available for these Gallery templates.
    • Immersion Portal.
    • Virtual Event Portal.
    • Live Event Portal.
    • Live Event In-Page.