Vii Events

Vii Events is an All-In-One 3D 360° virtual events platform. You can embed the activation using iFrame into the Vii Events virtual environment.

Automatically Identifying Players

The integration with Vii Events supports automatic identification of players. When a game is embedded into Vii Events, you can skip the form as we’ll already know who they are. This makes for a better user experience and simpler workflow when awarding prizes or posting points to a leaderboard. To make this work, here’s what you need to do:

When iFraming a game you could dynamically append a Universally unique identifier (UUID) to the "webhook_var[UUID]" query string parameter. This webhook_var parameter will be forwarded back to your inbound webhook endpoint URL.

Here's an example of embedding a game with an attendee that has a UUID of 56:

https://local-play.captello.com/Activations/loader/index.html?game=REARRANGE_WORDS&token=SKMq9wxebZrpwa4U1628010677&is_web_portal=0&webhook_var[UUID]=56

If you need to forward more parameters to the webhook, then it is better to name the parameter as something like webhook_var_parameter. So, you can have different parameters like: webhook_var_param1=x&webhook_var_param2=y&webhook_var_param3=z

Sending Points to Vii Events Leaderboard

A common use case for calling a webhook after an activation is played is to send a player’s score to a 3rd party leaderboard, such as Vii event. In this scenario, the activation can be iFramed into a web page or virtual event platform. One or more query string parameters can be dynamically added to the end of the game URL and then forwarded on to the inbound webhook endpoint URL. You can find more details on our Activation Webhook here.

To setup a webhook, go to the Action tab of the Activation builder page. Here, you would need to provide your Endpoint URL. Your webhook endpoint URL from Vii Events will look something similar to this: https://vii.events/api/webhooks/captello/?apiKey=e67a3734d9aa616d4372621e7

Here are a few things to note when setting up your webhook in the Activation Builder:

  1. Use the +/- to add/remove one or more webhooks. Multiple webhooks can trigger simultaneously.

  2. Choose to send our standard payload to your Endpoint URL or select one of our integrations to send a payload formatted for the integration partner.

  3. Enter the Endpoint URL where you want us to send the payload. Make sure you have a script to parse the payload. This would be your inbound webhook URL.

  4. Decide whether or not to include Prospect information (email, name, etc.) to adhere to your company’s privacy policy.

Retrieving Captello game URL

To get the game URL, do the following:

  • In Captello, navigate to Events > Activations

  • Next to the Activation you’d like to embed, click the down arrow and select Launch

Note, you can also get the embed link from the Action step within the Activation Builder.

  • Click the Copy button in the modal.

  • Make sure to use the Without Capture setting as shown below when embedding into Vii Events.