Hosts essentially act as a moderator of a room. They can admit guests into the chat who are in the waiting room, remove guests from the chat, and invite guests, among other features. The host ID is used to designate a host for a room without requiring them to be signed in as an Administrator of the chat space.

There is a host ID that is predefined for each chat space, which should be used in the embed code. Any user with access to the embed (that includes the ID) can be the host of any chat in the chat space, regardless of configuration.

Using the Host ID

Host IDs are usually passed into the embed code by a host parameter in the URL, or a host-token attribute when using the NPM package.

You can find the ID in the chat space Settings panel under Embed Options. The ID can be passed into any of the following methods of embedding.


For the Button Embed option, include the ID as a parameter in the script src URL. For example:

<script crossorigin="anonymous" async src="https://api.zipcan.com/script.js?token=CHAT_SPACE_TOKEN&host=HOST_ID"></script>
For the Inline Embed option, include the ID as a parameter in the iframe src URL. For example:

<div style="position:relative; width:100%; min-height: 500px; padding-bottom:65%; box-sizing: border-box;">
    <iframe id="zc-embed" width="100%" height="100%" style="position:absolute; top:0; left:0; width:100%; height:100%;" src="https://video.zipcan.com/CHAT_SPACE_TOKEN?host=HOST_ID" frameborder="0" allow="autoplay; picture-in-picture; camera; microphone; display-capture" allowfullscreen></iframe>
    <script crossorigin="anonymous" async src="https://api.zipcan.com/iscript.js"></script>
</div>

For the Advanced Embed option (using NPM), include the ID as an attribute call "host-token" in the web component. For example:

import "zipcan-video/zipcan-video.js";
<zipcan-video
    token="CHAT_SPACE_TOKEN"
    host-token="HOST_ID"
    [options]
></zipcan-video>
Note: Be sure not to confuse the general "token" with "host-token". The general "token" in the NPM example is used to identify the chat space.

For more information on the Advanced Embed option, visit https://www.npmjs.com/package/zipcan-video.

If you are not dynamically passing the ID into the embed code to designate a specific user for the host role, you may want to manually embed the video in a separate "host-only" location that contains the ID, while an embed with the host ID would exist in a different location for general guests.