Versions Compared

Version Old Version 10 New Version Current
Changes made by

Tristan Penman

Blake Irving

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

Please note: For the Vivi Emergency API to operate, your existing emergency management system needs to be able to output a web-based trigger (HTTPS GET or PUT methods). Please refer to the manufacturer’s instructions of your system for more information on if this is available.

...

In the triggers, you will need to insert your Emergency Type ID and have the option of including the Location ID. The Emergency Type ID is the name of the emergency as shown in Vivi Central. Emergency types can be viewed and edited at: https://admin.vivi.io/emergencies/emergency-types. The Location ID is the name of a location or sub- location as shown in Vivi Central. Locations and sub-locations can be viewed and edited at: https://admin.vivi.io/organisations/locations.

...

Info

<api_key>: Organisation API key – Required
<emergency_type_id>: ID of emergency type to trigger – Required
<location_id>: ID of location to trigger emergency at - Optional, trigger organisation wide emergency if not provided

...

Note

The location ID provided in the URL must be for a top level Location. Triggering Emergencies at the sub-location level is not supported.

Cancelling an Emergency

Your emergency management system needs to output the following URL to cancel an emergency:

...

Info

<api_key>: Organisation API key – Required
<emergency_type_id>: ID of emergency type to cancel, or all – Required
<location_id>: ID of location to cancel emergency at - Optional, cancel all emergencies currently active of the emergency type if not provided

Info

Note: Passing all as the emergency_type_id, without a location_id will cancel all active emergencies within your organisation, regardless of emergency type. location_id can still be used in conjunction with all.

Checking Active Emergency Types

Your emergency management system needs to read from the following URL to check active emergency types:

https://api.vivi.io/api/public/v1/emergencies/status?key=<api_key>&location=<location_id>

Note

This is only available via a GET request, not PUT

Info

<api_key>: Organisation API key – Required
<location_id>: ID of location to check - Required

Info

Example responses:

Code Block
{
  "emergency_types": ["0c17f5c8-77e2-4a79-a03e-b4610fc610fc"]
}
Code Block
{
  "emergency_types": []
}

Tracking Emergencies

The Emergencies page in Vivi Central can be used to view and cancel currently active emergencies and stores a full history of previously run emergencies. This page can be accessed at: https://admin.vivi.io/emergencies

...

Code Block
wget "https://api.vivi.io/api/public/v1/emergencies/trigger?key=my_key&type=9716eec6-112f-4940-b1b5-16f3d66ca2ea&location=6e7873b3-05e4-4ac6-8719-db049d53fbee"

...