WAVE: How do I create a generic event?

Summary

A generic event in Wisenet WAVE is a way to receive HTTP POST requests (or TCP messages) from external systems (e.g., third-party cameras) into Wisenet WAVE. These events can be filtered and trigger actions like notifications, recording, bookmarks, etc.

This article provides instructions for sending an API call as an HTTP request to generate a generic event in the Wisenet WAVE Client, as well as how to configure a generic event and event action from the Wisenet WAVE VMS. By following these steps, you can trigger a generic event in the system from a third party system.

Creating a User Account

To create a user account for a Generic Event:

1. Log in to the WAVE Client.
   
   
2. Open the System Administration menu by clicking Ctrl + Alt + A.
   
   
   
   
3. Navigate to Users and select New User.
   
   
4. Complete the fields in the User Information window and select Advanced Viewer from the Role drop-down menu.
   
   
   
   
5. Click the three dots next to the Enable toggle and click Allow digest authentication for this user.
   
   
   
   
6. Click OK to complete adding the user.

Confirming Third-Party Camera Can Send Events

Users must ensure that third-party cameras can send an HTTP POST request (usually triggered by motion, analytics, etc.). The basic format WAVE expects is:

http://<server_ip>:7001/api/createEvent?source=<source>&caption=<caption>&description=<description>

Example: http://192.168.1.100:7001/api/createEvent?source=Cam1&caption=Motion&description=MotionDetected

• source: The name or identifier of the device sending the event (See extended note after the instructions)
  
  
• caption: A label that will appear in WAVE (e.g., "Motion")
  
  
• description: More details (optional)
  

Testing an API Call (HTTP Request) 

You can test an API call with the web browser to generate a generic event.

1. Open a web browser and enter the following WAVE API command to generate a Generic Event.
   
   https://WAVEServerIP:7001/api/createEvent?caption=test
   
   Example: https://127.0.0.1:7001/api/createEvent?caption=test
   
   
2. Enter the username and password you created for the generic event.
   
   
   
   Once you successfully send the API call, you will see the following result from your web browser:
   
   {
   "error": "0",
   "errorId": "ok",
   "errorString": ""
   }
   
   
3. From the WAVE Client, confirm that there is a new notification of a Generic Event in the NOTIFICATIONS tab.
   
   
   

Generating a Generic Event

To generate a Generic Event with a specific camera:

1. Right click on the camera to use and select Camera Settings.
   
   
2. Select the down arrow under Vendor to find and copy the Camera ID. 
   
   
   
   
3. Open a web browser and enter the following WAVE API command:
   
   http://WAVEServerIP:7001/api/createEvent?caption=test&metadata={"cameraRefs":["d22704a6-3d8b-4d2b-53c5-1c604fcf0363"]}
   
   Once you successfully send the API call, the generic event is executed with that specific camera's snapshot.
   
   
   

NOTE: You can also add various parameters such as timestamp, source, 
description, etc. Refer to the Wisenet WAVE API document for more
information about the Generic Event API at the following URL:

https://WAVE server IP:7001/#/api-tool/api-createevent-post?type=1

Creating a Rule in Wisenet WAVE

To create a rule:

1. Open WAVE.
   
   

2. Select System Administration > Rules.
   
   

3. Click Add.
   
   

4. Under When select Generic Event.
   
   The following filters appear: 
   
   o Source
   o Caption
   o Description
   
   These are the fields that must match the incoming HTTP POST.

   NOTE: These fields can be left blank to match all events, or be 
   specific (e.g., Caption = Motion, Source = Cam1).

5. After the event is matched, you can trigger actions like:

   • Show Notification
   • Start Recording
   • Send Email
   • Bookmark
   
   

6. Set the action according to your goal. For example: 

   • Select Show Notification
   • Select User(s).
   • Customize message (optional).
   
   

7. Test by sending the HTTP request manually (using browser or curl) or triggering the camera’s event mechanism, see Testing an API Call (HTTP Request).

Example

Camera sends HTTP POST to:

http://192.168.1.100:7001/api/createEvent?source=CamBackYard&caption=PersonDetected&description=AIAnalytics

In Wisenet WAVE:

• Rule: Generic Event
  o Source: CamBackYard
  o Caption: PersonDetected
  
  
• Action: Show Notification to User “Admin”
  
  
• Result: When the camera detects a person, it sends the event and you see a popup notification.

NOTE: For the source field in the createEvent URL and in the rule, you can use any 
arbitrary string. It does not need to be the camera’s name (but that would be 
the easiest way to identify it), ID, or MAC address. But it must match exactly 
between the event URL and your Generic Event Rule filter.

The source field is a custom label that is used only for filtering in the Generic Event rule. It does not automatically link to a specific camera in your system unless you pair it manually (e.g., through rule actions).
Choose:

• source=BackYardCam
• source=Camera123
• source=00:1A:2B:3C:4D:5E (MAC)
• source=Bosch123 (device name)

The string in the createEvent URL must match the filter in the Wisenet WAVE rule (or is left blank to catch all).

Tips

If the event is coming from a specific camera, to keep things clear, use something:

• Easy to recognize
  Unique if you have multiple cameras sending events

Example:

http://192.168.1.100:7001/api/createEvent?source=FrontDoor&caption=Motion&description=MotionDetected

In WAVE:

• Generic Event Rule:
  o Source: FrontDoor
  o Caption: Motion
  o Description: (leave blank or use MotionDetected)
  
  Action: Show notification, start recording, etc.