Skip to content

Adds Add-VerkadaHelixEvent function #264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bepsoccer merged 3 commits into from
Oct 21, 2025
Merged

Adds Add-VerkadaHelixEvent function #264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6779b76
Adds Add-VerkadaHelixEvent function
bepsoccer Oct 21, 2025
9afc918
Merge pull request #262 from bepsoccer/261-add-verkadahelixevent
bepsoccer Oct 21, 2025
6bd2f72
Merge pull request #263 from bepsoccer/260-add-helix-endpoints
bepsoccer Oct 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 110 additions & 0 deletions verkadaModule/Public/Add-VerkadaHelixEvent.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
function Add-VerkadaHelixEvent{
<#
.SYNOPSIS
Creates a Helix event in Commadn using https://apidocs.verkada.com/reference/postvideotaggingeventviewv1

.DESCRIPTION
This method can be used to generate a Helix Event in Command. Users will be able to specify the attribute values for each attribute key that was previously defined in the Event Type creation process. To successfully create a Helix Event, users will need to input the associated Camera ID, API Token with Helix permissions, Event Type UID, and the exact event epoch timestamp in milliseconds.
The org_id and reqired token can be directly submitted as parameters, but is much easier to use Connect-Verkada to cache this information ahead of time and for subsequent commands.

.LINK
https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Add-VerkadaHelixEvent.md

.EXAMPLE
Add-VerkadaHelixEvent -camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -timeStamp (get-date) -attributes $attributes
This will add a new helix event for the current time for the sepcified camera, event ID, and submitted attributes. The org_id and token will be populated from the cached created by Connect-Verkada.

.EXAMPLE
Add-VerkadaHelixEvent -camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -timeStamp '1/1/2025 08:35:00 -06' -attributes $attributes -org_id '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token'
This will add a new helix event for Jan 1, 2025 at 8:35 AM CST for the sepcified camera, event ID, and submitted attributes. The org_id and token are submitted as parameters in the call.
#>
[CmdletBinding(PositionalBinding = $true)]
[Alias("Add-VrkdaHlxEvt","a-VrkdaHlxEvt")]
param (
#The UUID of the organization the user belongs to
[Parameter(ValueFromPipelineByPropertyName = $true)]
[ValidateNotNullOrEmpty()]
[ValidatePattern('^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$')]
[String]$org_id = $Global:verkadaConnection.org_id,
#The UUID of the camera who's name is being changed
[Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)]
[ValidatePattern('^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$')]
[Alias("cameraId")]
[String]$camera_id,
#The UID of the event type to be used when creating the event
[Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)]
[ValidatePattern('^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$')]
[String]$event_type_uid,
#The the epoch time of the event
[Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)]
[datetime]$timeStamp,
#The parameters to be submitted for the event
[Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)]
[object]$attributes,
#Boolean if the event should be flagged
[bool]$flagged=$false,
#The public API token obatined via the Login endpoint to be used for calls that hit the public API gateway
[Parameter()]
[ValidateNotNullOrEmpty()]
[String]$x_verkada_auth_api = $Global:verkadaConnection.x_verkada_auth_api,
#The region of the public API to be used
[Parameter()]
[ValidateSet('api','api.eu','api.au')]
[String]$region='api',
#Switch to write errors to file
[Parameter()]
[switch]$errorsToFile
)

begin {
$url = "https://$($region).verkada.com/cameras/v1/video_tagging/event"
#parameter validation
if ([string]::IsNullOrEmpty($org_id)) {throw "org_id is missing but is required!"}
if ([string]::IsNullOrEmpty($x_verkada_auth_api)) {throw "x_verkada_auth_api is missing but is required!"}
$myErrors = @()
} #end begin

process {
$epoch_time = (New-TimeSpan -Start (Get-Date "01/01/1970") -End $timeStamp.ToUniversalTime()).TotalMilliseconds
$body_params = @{
'camera_id' = $camera_id
'event_type_uid' = $event_type_uid
'time_ms' = $epoch_time
'attributes' = $attributes
'flagged' = $flagged
}

$query_params = @{}

try {
Invoke-VerkadaRestMethod $url $org_id $x_verkada_auth_api $query_params -body_params $body_params -method POST
return "Event created successfully"
}
catch [Microsoft.PowerShell.Commands.HttpResponseException] {
$err = $_.ErrorDetails | ConvertFrom-Json
$errorMes = $_ | Convertto-Json -WarningAction SilentlyContinue
$err | Add-Member -NotePropertyName StatusCode -NotePropertyValue (($errorMes | ConvertFrom-Json -Depth 100 -WarningAction SilentlyContinue).Exception.Response.StatusCode) -Force
$msg = "$($err.StatusCode) - $($err.message)"
$msg += ": $(($query_params + $body_params) | ConvertTo-Json -Compress)"
Write-Error $msg
$myErrors += $msg
$msg = $null
}
catch [VerkadaRestMethodException] {
$msg = $_.ToString()
$msg += ": $(($query_params + $body_params) | ConvertTo-Json -Compress)"
Write-Error $msg
$myErrors += $msg
$msg = $null
}
} #end process

end {
if ($errorsToFile.IsPresent){
if (![string]::IsNullOrEmpty($myErrors)){
Get-Date | Out-File ./errors.txt -Append
$myErrors | Out-File ./errors.txt -Append
}
}
} #end end
} #end function
23 changes: 12 additions & 11 deletions verkadaModule/verkadaModule.psd1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#
# Generated by: Verkada SE Community
#
# Generated on: 09/30/2025
# Generated on: 10/19/2025
#

@{
Expand Down Expand Up @@ -72,9 +72,9 @@ PowerShellVersion = '6.1'
FunctionsToExport = 'Add-VerkadaAccessGroup', 'Add-VerkadaAccessSiteAdmin',
'Add-VerkadaAccessUserCard', 'Add-VerkadaAccessUserLicensePlate',
'Add-VerkadaCamera', 'Add-VerkadaCommandSite',
'Add-VerkadaCommandUser', 'Add-VerkadaLicensePlateOfInterest',
'Add-VerkadaWorkplaceEmployee', 'Connect-Verkada',
'Disable-VerkadaAccessUserCard',
'Add-VerkadaCommandUser', 'Add-VerkadaHelixEvent',
'Add-VerkadaLicensePlateOfInterest', 'Add-VerkadaWorkplaceEmployee',
'Connect-Verkada', 'Disable-VerkadaAccessUserCard',
'Disable-VerkadaAccessUserLicensePlate', 'Disconnect-Verkada',
'Enable-VerkadaAccessUserCard',
'Enable-VerkadaAccessUserLicensePlate', 'Find-VerkadaCommandUser',
Expand Down Expand Up @@ -130,13 +130,14 @@ CmdletsToExport = @()
# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
AliasesToExport = 'a-VrkdaAcGrp', 'Add-VrkdaAcGrp', 'a-VrkdaAcUsrCrd',
'Add-VrkdaAcUsrCrd', 'a-VrkdaAcUsrLPR', 'Add-VrkdaAcUsrLPR',
'a-VrkdaCmdUsr', 'Add-VrkdaCmdUsr', 'Add-VerkadaLPoI', 'a-VrkdaWrkEmp',
'Add-VrkdaWrkEmp', 'd-VrkdaAcUsrCrd', 'Disable-VrkdaAcUsrCrd',
'd-VrkdaAcUsrLPR', 'Disable-VrkdaAcUsrLPR', 'e-VrkdaAcUsrCrd',
'Enable-VrkdaAcUsrCrd', 'e-VrkdaAcUsrLPR', 'Enable-VrkdaAcUsrLPR',
'otp', 'Get-VrkdaAcEvnts', 'gt-VrkdaAcEvnts', 'Get-VrkdaAcGrp',
'gt-VrkdaAcGrp', 'Get-VrkdaAcUsr', 'gt-VrkdaAcUsr',
'ep-VrkdaAcUsrPrflPic', 'Export-VerkadaAccessUserProfilePicture',
'a-VrkdaCmdUsr', 'Add-VrkdaCmdUsr', 'a-VrkdaHlxEvt', 'Add-VrkdaHlxEvt',
'Add-VerkadaLPoI', 'a-VrkdaWrkEmp', 'Add-VrkdaWrkEmp',
'd-VrkdaAcUsrCrd', 'Disable-VrkdaAcUsrCrd', 'd-VrkdaAcUsrLPR',
'Disable-VrkdaAcUsrLPR', 'e-VrkdaAcUsrCrd', 'Enable-VrkdaAcUsrCrd',
'e-VrkdaAcUsrLPR', 'Enable-VrkdaAcUsrLPR', 'otp', 'Get-VrkdaAcEvnts',
'gt-VrkdaAcEvnts', 'Get-VrkdaAcGrp', 'gt-VrkdaAcGrp', 'Get-VrkdaAcUsr',
'gt-VrkdaAcUsr', 'ep-VrkdaAcUsrPrflPic',
'Export-VerkadaAccessUserProfilePicture',
'Export-VrkdaAcUsrPrflPic', 'g-VrkdaAcUsrPrflPic',
'Get-VrkdaAcUsrPrflPic', 'g-VrkdAlrmDevs', 'Get-VrkdAlrmDevs',
'Get-VerkadaCameraSite', 'Get-VrkdaCmdUsr', 'gt-VrkdaCmdUsr',
Expand Down