Versions Compared

Version Old Version 13 New Version Current
Changes made by

Dean Levinson

Blake Irving

Saved on

Key

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

...

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

...