Application primers

Last modified: Wednesday July 02, 2025.

The following examples outline the steps and API operations required to perform some common integration tasks.

View alarm video using a shared link

1. Configure an external link and webhook as alarm actions for the zone. See Alarm and arm/disarm actions.
2. Include the $alarmZoneId in the webhook payload.
3. When the webhook triggers, get a list of ongoing alarms using /api/v1/ongoingAlerts
4. Find the alarm guid by matching the alarm_zone_id in the response with the $alarmZoneId in the webhook payload.
5. Get a list of bookmarks for the alert using /api/v1/alerts/<guid>/bookmarks
   1. If an external link is configured as an alarm action, the system automatically boomarks video of the incident.
6. Extract the guest_token from each bookmark.
7. Create and share a link to each video: https://<deploymentname>.<region>.alta.avigilon.com/cloud?t=<guest_token>

Verify an ongoing alarm

1. Configure a webhook as an alarm action for the zone. See Alarm and arm/disarm actions.
2. Include the $alarmZoneId and $deviceId in the webhook payload.
3. When the webhook triggers, get a list of ongoing alarms using /api/v1/ongoingAlerts
4. In the response:
   1. Find the alarm guid by matching the alarm_zone_id with the $alarmZoneId in the webhook payload.
   2. Find if the alarm is merged. Similar detections within a short space of time are merged into a single ongoing alert.
   3. You can also extract the origin_name if you didn’t pass $deviceId in the webhook.
5. Change the verification status by posting the acknowledgment_code, guid, merged, and origin_name to /api/v1/alerts/<guid>
6. Pass the acknowledgment_code as:
   1. 101 for none
   2. 201 for valid
   3. 202 for false

End an ongoing alarm

1. Configure a webhook as an alarm action for the zone. See Alarm and arm/disarm actions.
2. Include the $alarmZoneId in the webhook payload.
3. Get a list of ongoing alarms using /api/v1/ongoingAlerts
4. Find the alarm guid by matching the alarm_zone_id in the response with the $alarmZoneId in the webhook payload.
5. End the alarm by posting /api/v1/alerts/<guid>/end

Useful API calls

The following API calls are useful for creating Alta Protect applications. For a full list of API calls, see https://alta-video.readme.io/reference/get_api-v1-about.

• /api/v1/alarmZoneAlerts
• /api/v1/alarmZoneAlerts/stopLocalOngoing
• /api/v1/alarmZoneAlerts/{alert_id}/{sub_alert_id}/details
• /api/v1/alarmZones
• /api/v1/alarmZones/arm
• /api/v1/alarmZones/disarm
• /api/v1/alarmZones/{alarm_zone_id}/arm
• /api/v1/alarmZones/{alarm_zone_id}/disarm
• /api/v1/alarmZones/{id}
• /api/v1/alarmZones/{id}/comment
• /api/v1/alarmZones/{id}/logs
• /api/v1/alarmZonesUserMuted
• /api/v1/alarmZonesUserMuted/{id}
• /api/v1/alerts
• /api/v1/alerts/{guid}
• /api/v1/alerts/{guid}/bookmarks
• /api/v1/alerts/{guid}/end
• /api/v1/ongoingAlerts
• /api/v1/publicIntrusionEmergencyContacts
• /api/v1/publicIntrusionEmergencyContacts/{id}
• /api/v1/publicIntrusionWebhooks