A current list of gate types, definitions and instructions for creating the payload formats expected for each.

Video #

SproutVideo #

SproutVideo is a video hosting and streaming service you can use to host your videos securely. A SproutVideo gate can securely stream a hosted video from your account and ensure that only token holders can watch.

In your SproutVideo account, your embed code will look something like the below. Use the section in bold only, when pasting into the gate payload area and the on-page script will do the rest.

<a href='https://videos.sproutvideo.com/embed/ac9fdbb71b1ae9cd25/3f0ae94dfedbf151?autoPlay=true' class='sproutvideo-lightbox' data-width='640' data-height='360'><img src='https://cdn-thumbnails.sproutvideo.com/ac9fdbb71b1ae9cd25/3f0ae94dfedbf151/0/w_640,h_360,btn_true/poster.jpg' style='max-width:100%'/></a><script charset='ISO-8859-1' src='https://c.sproutvideo.com/lightbox/v1.0.0.js'></script>

Vimeo (Hidden) #

For your Vimeo videos that you have set to Hidden status.

 https://player.vimeo.com/video/861741044?h=a4d867ef3e

Vimeo (Private) #

Vimeo videos set to Private require a slightly different embed code.

<div style="padding:56.25% 0 0 0;position:relative;"><iframe src="https://player.vimeo.com/video/896069327?badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" frameborder="0" allow="autoplay; fullscreen; picture-in-picture; clipboard-write" style="position:absolute;top:0;left:0;width:100%;height:100%;" title="2023-11-25 19-06-59"></iframe></div><script src="https://player.vimeo.com/api/player.js"></script>

Live Streaming #

SproutVideo Lightbox #

If you are live streaming through SproutVideo and a local broadcast software like OBS Studio, the livestream details page will contain your embed code. Copy only the section in bold as the gate payload.

<a href='https://videos.sproutvideo.com/embed/ac9fdbb71b1ae9cd25/3f0ae94dfedbf151?autoPlay=true' class='sproutvideo-lightbox' data-width='640' data-height='360'><img src='https://cdn-thumbnails.sproutvideo.com/ac9fdbb71b1ae9cd25/3f0ae94dfedbf151/0/w_640,h_360,btn_true/poster.jpg' style='max-width:100%'/></a><script charset='ISO-8859-1' src='https://c.sproutvideo.com/lightbox/v1.0.0.js'></script>

Tickets (QR) #

A gate type of Tickets will take any data that you enter into the payload section and render it as a QR code. This can be useful for several scenarios:

1. Being able to redirect the user through a mobile scan
2. Providing coupon codes or discounts you have programmed into your POS system or cash register
3. Providing a simple “OK” message for facilitating in-person events

Redirection #

A redirection type gate will assume that the payload you entered is a valid URL, and automatically redirect the user. Redirection is especially useful for doing things like creating coupon codes ahead of time, and applying a one-time use coupon code redirection to your shopping cart for each gate.

Plain Text #

In some scenarios you want the consumer to simply see a certain passphrase, codeword or other information in plain text format. This payload is simply rendered to the screen as text.

Custom Applications #

Sometimes you want the raw data in the payload to be handled in a custom way for advanced applications.

Inject HTML #

Treat the payload as HTML and render it to the screen. You can include rich text formatting and custom scripts to be run on-page.

Custom Script (Passthrough) #

Pass the payload data along to a custom function that you have made yourself in place of the standard on-page script. If you are a developer who wants to include game character data or other large rich datasets as the gate payload, you can use the Passthrough payload type to receive the payload by your calling function and handle the data in whichever way you choose.