Scenarios

Running a scenario

Running/invoking a scenario triggers the communication to the intended recipients. The message (static or dynamic) will be sent on all the provided channels.

Running a scenario is easy. The specific scenario has to be called via a /POST request. For example:

  1. Get all the scenarios.
  2. Pick the required scenario’s link attribute.
  3. Make a /POST call.

From the retrieving scenarios call above, you can get all the scenarios in the workspace. Choosing the Emergency Comms - Fire scenario, the link provided is https://api.<region>.whispir.com/scenarios/F0547F6F2E4839F8?apikey=[your_api_key]

Now, invoking this scenario just involves making a /POST call. There is no need for a content-type header as the payload is empty.

  • JSON
  • XML

Running a scenario

A simple POST call to the /scenarios endpoint with the scenario ID triggers the scenario:

HTTP 1.1 POST https://api.<region>.whispir.com/scenarios/F0547F6F2E4839F8?apikey=[your_api_key]
Authorization: Basic asdf98nf89asdvasd2r398h8sdf
x-api-key: your_api_key 
> > The expected response to this call is an HTTP 204 - No Content.