Vivotek Vortex Prerequisites & Installation Guide

VIVOTEK VORTEX is a cloud-based Video Management System (VMS) that enables secure device management, live video streaming, playback, event handling, and I/O control through APIs and web SDKs.

This documentation provides an end-to-end view of how VIVOTEK VORTEX devices are onboarded, configured, streamed, and controlled within the platform, and how external applications can integrate with VORTEX using REST APIs and the VORTEX Streaming SDK.

➤ Platform

• VORTEX Cloud Services  ( Link: https://vivotek-it.github.io/vortex-external/getting-started)

• VORTEX Web Portal (Client Tool) (Link : https://portal.vortexcloud.com/)

• VORTEX External APIs  (Link: https://vivotek-it.github.io/vortex-external/public)

• VORTEX Streaming SDK (Link: https://vivotek-it.github.io/vortex-external/vortex-streaming)

• Edge Devices (Cameras, NVRs, I/O devices)

1. Prerequisites  

Before proceeding, ensure the following:

• A valid VIVOTEK VORTEX account.

• Access to the VIVOTEK VORTEX Web Portal (Client Tool).

2. Authentication & Authorization

• VORTEX APIs uses token-based authentication.

• All API requests must include the required authorization headers.

 3. Device Onboarding & Configuration

• Log in to the VIVOTEK VORTEX Web Portal

• Navigate to My Account → API Key Management, and click Add option.

•   To generate an API key and Keep it secure

•   Navigate to the Device menu, then click the Add button to create a site.

• Navigate to the Authentication section in the VORTEX Open API portal (https://vivotek-it.github.io/vortex-external/public).

• Locate the HTTP Bearer authentication panel.

• Enter your generated API key in the provided input field.

• Click the SET button to apply the API key.

• Navigate to the Groups → Get all groups section in the VORTEX Open API portal.

• In this context, a Group represents a Site in the system.

• Click the TRY button to execute the API request.

• The API will return a list of all available sites (groups).

• Each site includes a unique identifier called groupId.

• Copy the required groupId from the response for use in  device discovery operations
  

• Click the Add button to create a device.

 4.Live Streaming

• Navigate to the View menu.

• Confirm that the live video feed is working as expected.

5.VIVOTEK VORTEX Integration in genesis

• Add VivotekVortex Parameters to Genesis:

• Parameter Type : string

• Parameter Name : VivotekVortex_Device_Custom_baseUrl

• Parameter Value : https://vivotekproxy.nxgen.cloud/

• Steps to add custom property:

• Step 1: Login to genesis

• Step 2: Navigate to configuration app

• Step 3: At service provider level, click on edit button under overview tab

• Step 4: Click on additional settings tab->Custom property

• Step 5: Scroll down and click on the "Add +" button

• Step 6: Enter parameter name and value as mentioned below

• Parameter Type : string

• Parameter Name : VivotekVortex_Device_Custom_baseUrl

• Parameter Value : https://vivotekproxy.nxgen.cloud/

• Add VivotekVortex device under the required site:

• Navigate to the Configuration section in Genesis.

• Navigate to Devices → Add New Device:

• Fill in the following details:

• Device Name : e.g., "Vivotek Vortex Camera - Gate A"

• Device Type : Vivotek Vortex

• API Key : “Use the API Key that you created earlier”

• External GroupID: “Use the Group ID (site) that you created earlier”

• Event Call back implemented for events necessary webhook need to be created at device level.

• cameraUniqueId: A unique value per camera or channel. Required for correct image fetch and archiving.

Click Save & Verify to confirm that the device is reachable and data (stream/events) is being received.

cameraUniqueId: A unique value per camera or channel. Required for correct image fetch.

• Copy the device ID for use in event configuration

• Navigate to Video Viewer.

 6.Events / Alarms (Webhook-Based Event Integration )

• Events / Alarms Document URL: https://vivotek.zendesk.com/hc/en-001/articles/39346040829849--VORTEX-Portal-How-to-configure-webhook-in-alarm-management

• This method uses Vivotek Vortex Webhooks, where the device actively sends events to our platform whenever an event occurs.

• You need to configure the webhook URL in the device web interface, pointing to our service endpoint.

• With the webhook feature in alarm management, you can configure automatic notifications to be sent to your specified URLs whenever a selected rule is triggered. This allows you to seamlessly integrate real-time alerts into your workflow or external systems.
   
  Setting Up a Webhook Profile in Alarm Management
  In the Alarm Management section, find and click the button to create a webhook profile.
  

  

1. Webhook Name: Your preferred webhook name (eg.NXGEN Remote Video Monitoring)

2. Integration URL: https://vivotekproxy.nxgen.cloud/EventIngest

3. •SSL Handling: "Ignore SSL Certificate Errors" option is enabled

4. Sending Method: By server

5. Payload Type: JSON

Payload 
{
  "organizationName": "{{.OrganizationName}}",
  "organizationId": "{{.OrganizationId}}",
  "eventType": "{{.EventType}}",
  "eventName": "{{.EventName}}",
  "eventId": "{{.EventId}}",
  "deviceName": "{{.DeviceName}}",
  "deviceId": "{{.DeviceId}}",
  "mac": "{{.Mac}}",
  "deviceGroupName": "{{.DeviceGroupName}}",
  "deviceGroupId": "{{.DeviceGroupID}}",
  "localTime": {{.LocalTime}},
  "timezone": "{{.Timezone}}",
  "alarmId": "{{.AlarmId}}",
  "profileName": "{{.ProfileName}}",
  "imageFace": "{{.ImageFace}}",
  "imagePerson": "{{.ImagePerson}}", 
  "nxgenDeviceId": "Enter nxgen device id  that you created earlier",

               }

• Note
  Currently, if you choose to send by cloud, IP address is not allowed for URL, use domain name instead.
  Don't use language other than English, as it can cause the webhook to fail.
  If the sending method is by device, make sure the receiving end and the device are on the same local network.

Below is the list of variables we have
Definition

After the webhook profile is created, you can set webhook as an alarm action, and choose which profile you would like to apply.

Add an Alarm to Send Webhook
1. Select the ‘Add alarm’ icon in the top right.

2. Select which event types that will trigger webhooks.

 

3. Select which device sources will trigger webhooks.

4. Select the webhook profile you created in the previous step.

 

5. Set the schedule for sending this webhook.

 6. Name this alarm and complete the setup.

Navigate to the Message Center menu to check the generated events and alarms.

• Navigate to Video Activity Search.