Product Updates | Contact Support | System Status
Page Contents

    Integrating Pigeonhole with a Virtual Event Experience

    In this topic you will learn how to integrate Pigeonhole with a Virtual Event Experience.

    Pigeonhole can be used to easily add event based interactivity (live Q&A, polls, surveys, etc.) to one or more videos in a Virtual Event experience. Typically, a new Pigeonhole is created for the duration of the live event and then sessions can be created for each video or breakout room you want to add Pigeonhole functionality to. To add interactivity to videos, iframe embed code is associated with each video using a Video Cloud custom field. The embed code will cause the Pigeonhole pod to display next to the video player for chosen videos.

    For breakout rooms, the session ID and passcode are added to the breakout session in the agenda.

    Creating a new Pigeonhole event and sessions

    You should create a new Pigeonhole for your live event and then add sessions for each video that will have Pigeonhole functionality added to it.

    1. Login to your Pigeonhole account.
    2. Click + Add Pigeonhole and click your account to use.
    3. Enter an Event name and Passcode.
    4. Enter Start and End dates for the event. These dates control how long the Pigeonhole will be active.
    5. Select a Timezone and Custom Branding option (if applicable).
    6. Click Continue.
    7. Now that the event is created the Agenda item will be selected in the left navigation. Click Add session and click Create new.
    8. Select a Session Type of Q&A (other session types can also be used).
    9. Enter a Session name.
    10. Enter Start and End dates and times.
    11. Configure the Q&A Settings as appropriate.
    12. Click Add Q&A and confirm the session was created.
    13. Create additional sessions as needed.

    Generating the Pigeonhole embed code

    In order for a Pigeonhole to display next to a video, iframe embed code will be added to video using a Video Cloud custom field. The format of the code will be:

    <iframe src="Pigeonhole URL"></iframe>

    To get the value for the pigeonhole URL, follow these steps.

    1. In Pigeonhole, click Run your event in the left navigation.
    2. Click the link in the Invite your attendees section.
    3. Confirm that a new browser tab with a list of all sessions opens.
    4. Click the enter link for the appropriate session, for example, Enter this Q&A. Note that the link will change based upon the session type.
    5. Confirm that the Pigeonhole opens in a new browser tab. The Pigeonhole URL is displayed in the browser address bar.

    The iframe tag with the Pigeonhole URL will be added to the appropriate video.

    Configuring event settings

    Settings for the Pigeonhole event must also be configured so the SSO information can be used to create a user profile.

    1. In the left navigation, click More settings.
    2. Click the Attendees tab.
    3. Check the Allow creating attendee profiles through embed option.
    4. Scroll down to the Registrant Profiles section on the page.
    5. Check the Enable registrant profile for this event option.

    Creating a custom field

    In order for the Virtual Event template to know which Pigeonhole to display for a video, a custom field is used. To create a custom field, follow these steps.

    1. Login to Video Cloud Studio.
    2. In the primary navigation, click Admin and then Video Fields. Note that you must be an account administrator to access to the Admin menu.
    3. Create a new custom field named Chat Embed.
    4. Confirm that the internal name is chat_embed.
    5. Set the Type to be Text.
    6. Save the custom field.

    For information on creating custom fields in Video Cloud, see Creating Custom Metadata Fields.

    Adding a Pigeonhole to a video

    To have a Pigeonhole appear next to a video in the Virtual Event template, follow these steps.

    1. Open the Media module.
    2. Click on a video to open the video properties.
    3. Locate the Custom Fields section and click Edit.
    4. Paste the Pigeonhole embed code into the Chat Embed custom field.
    5. Click Save.

    Getting the Pigeonhole session ID

    When a session type of Breakout Room is added to the agenda, Pigeonhole can be used to easily add event based interactivity (live Q&A, polls, surveys, etc.) to the breakout room. The agenda requires that the Pigeonhole session ID and passcode be entered. Follow these steps to get the Pigeonhole session ID.

    1. Login to your Pigeonhole account.
    2. Click the Event name.
    3. Click Agenda in the left navigation.
    4. Locate the breakout room session.
    5. Click the dropdown arrow to display the Session ID.

    Getting the Pigeonhole passcode

    When a session type of Breakout Room is added to the agenda, the Pigeonhole session ID and passcode be must be entered. Follow these steps to get the Pigeonhole passcode.

    1. Login to your Pigeonhole account.
    2. Locate the Event name.
    3. The Pigeonhole passcode is displayed above the event name.

    Passing user SSO information to Pigeonhole

    If your Virtual Event Experience is secured using SSO, it is possible to pass user SSO information to Pigeonhole so that users can be tracked inside of Pigeonhole. The following sections walk through the settings and steps that are needed to pass SSO information to Pigeonhole.

    Map SSO attributes

    You need to ensure that the correct SSO attributes are mapped so they can be passed to your experience and then to Pigeonhole. The integration Pigeonhole looks for the following values:

    • fname - User's name
    • nameID - User's email address

    The example below shows these attributes being exposed from inside the Okta SSO Admin page.

    Expose attributes in the Access Control Profile

    Ensure that the Access Control Profile used to secure the experience has the Expose all attributes option checked. If the SSO information is not available, users will appear as anonymous in Pigeonhole.

    1. Open the Gallery module.
    2. Click the settings icon () on the home page.
    3. In the left navigation, click Access Control Profiles.
    4. Click the edit icon for the profile being used to secure the experience.
    5. Ensure that the Expose all attributes setting is checked.

    For information on configuring single sign-on, see Configuring Access Control Profiles. If everything is configured correctly, the user info will display in Pigeonhole when the viewer logs into the experience.


    Page last updated on 26 Jul 2022