V1 Dynamic Site Creation (Event Based) (Deprecated)

Introduction

This document describes how you can create Hovr custom site from your website on demand. Using integration token you can create a site from your portal with minimum required data.

📘

Prerequisites

Before you can implement the easy on demand create site for your Hio Hovr integration, you need to request an integration token from your Hio Account manager. This token will be delivered to your development team in a secure manner.

The technical changes needed on your website/webapp are minimal but requires a web developer/engineer who can make changes to the backend and frontend of your website. This requires a moderate level of technical knowledge of your platform unlike the standard Hio Hovr setup that requires very basic understanding of your website and can be done by a non-technical person in most cases.

❗️

Adding to correct location

If your event uses different HTML files for each tab/ sub tab the snippet of code will need to be added to something that is used across all HTML files. An example of this would be a common footer html tag that all web pages use. If there is not a reusable component to each page then the widget will need to be added to each pages body html tag.

Client Steps

1. Locate in your code where the event creation occurs for administrators. Provide them with the option to 'Add Hio' to their event.
2. Each event should have a unique URL. Before making the API call to create site creation make sure that you have what that URL will be.
3. Make the callout to Dynamic Site Creation endpoint from a backend method (Information about API is added below).
• In order to use our API you must have an integration token. If you do not have one please reach out to your customer support representative.
• We ask that this come from a backend method for a more secure API call.
4. Consume JSON response to indicate that the site was successfully created for the event.
5. Add the script below to the event's HTML inside the body HTML tag.
   • Please see How to Append Code Snippet to Child of Common HTML Tag for help appending the snippet.
   • This needs to be added to a common HTML tag like a header or footer that is used across the webpage. If there is no tag like this then the code snippet will need to be appended to each individual page.
   • This HTML tag will need to have a unique ID attribute in order to append the snippet

Example of Snippet of code to be added to HTML

HTML

<div id="hio-site-identifier" data-id="10"></div>
<script src="https://plugin-helper.hiosocial.com/plugin_loader.js"></script>

How to Append Code Snippet to Child of Common HTML Tag

JavaScript

//simulating already getting reponse from API call
let hovrSnippet = <div id="hio-site-identifier" data-id="10"></div>
<script src="https://plugin-helper.hiosocial.com/plugin_loader.js"></script>;
document.getElementById("myUniqueHeaderId").appendChild(hovrSnippet);

End Points

Production Environment:
https://prod-gcf.hiosocial.com/integration/site/create

Usage

Method:
POST

Header

Field	Description	Required
Authorization	Integration Token(from HIO)	Yes
Content-Type	application/json	Yes

Body(JSON)

Field	Description	Default	Required
name	String: Name of the site		Yes
subheader	String: Site Header that appears on the hovr plugin.	We're making websites social, check it out.	No
integration_type	String Set values : "any_website", “entire_website”, “specific_subdomain”, "page_startswith", "specific_page" (See Below for Additional Information)	N/A	Yes(if status is live)
integration_url	String Site URL	N/A	Yes
conversion_url	String Site URL		No
primary_hex_color	String hex code for color	#002B61	No
secondary_hex_color	String hex code for color	#002B61	No
is_networking_enabled	Boolean is network card enabled	True	No
is_one_to_one_text _chat_enabled	Boolean is one to one chat enabled	True	No
is_open_channels_enabled	Boolean is open chat enabled	True	No
open_channels _create_permission	String set values: "creator", "anyone"	creator	No
is_one_to_one_video _chat_enabled	Boolean Enable one to one video chat(feature not available at this time)	False	No
is_vip_table_video _call_enabled	Boolean Enable vip table video chat(feature not available at this time)	True	No
is_chat_profanity _filter_enabled	Boolean	True	No
number_of_channels	String set values: "multiple_channels", "single_channel"	multiple_channels	No
is_single_sign_on	Boolean	false	No
status	String set values: "draft", "live", "unpublished"	N/A	Yes
card_configuration	See Below for Structure, this is an array	Default listed below	No
channels	See Below for Structure	N/A	Yes
is_embedded	Boolean	False	No

integration_type additional detail

Option	Explanation
Multiple websites	Use this option if you would like to use this configuration on multiple website
Entire websites	Use this option if you would like to use this configuration on your whole website
Specific subdomain	Use this option if you would like to use this configuration on a subdomain and its extensions.
Pages start with	Use this option if you would like to use this configuration that start with a specific pathway and its extensions
Specific Pages	Use this option if you would like to use this configuration

card_configuration

Field	Description	Default	Required
custom_name	String Name of Card	N/A	Yes
text_description	String About the card	N/A	Yes
card_Identifier	Decimal set values: 1 for Networking, 2 for Open Chat Channels, 3 for Connection, 4 for Direct Message, 5 for FAQs & Privacy	N/A	Yes
hex_primary	String hex color code	N/A	Yes
hex_secondary	String hex color code	N/A	Yes

card_configuration default

JSON

[
{
"custom_name": "Networking",
"text_description": "Build relationships with interesting people.",
"card_identifier": 1,
"hex_primary": "#002B61",
 "hex_secondary": "#c1c1c1"
},
{
"custom_name": "Open Chat Channels",
"text_description": "Engage in live chat conversations.",
"card_identifier": 2,
"hex_primary": "#002B61",
"hex_secondary": "#c1c1c1",
 },
 {
"custom_name": "Connections",
"text_description": "Easily follow up and build relationships.",
"card_identifier": 3,
"hex_primary": "#002B61",
"hex_secondary": "#c1c1c1",
},
{
"custom_name": "Direct Message",
"text_description": "Send and receive 11 chat messages.",
"card_identifier": 4,
"hex_primary": "#002B61",
"hex_secondary": "#c1c1c1",
 },
{
"custom_name": "FAQs & Privacy",
 "text_description": "View Hio privacy, data, and security information.",
"card_identifier": 5,
"hex_primary": "#002B61",
"hex_secondary": "#c1c1c1",
}
 ]

channels

Field	Description	Default	Required
title	string name of channel	N/A	Yes

Default Array

JSON

[
 {
	"title": "General Chat"
 },
 {
	"title": "Announcements"
 },
 {
	"title": "Intros"
 },
 {
 	"title": "Asks/offers"
 },
 {
	"title": "Random"
 }
]