Introduction

Alert model

Example

{
  "id": 10,
  "audience_id": 572,
  "type": "Fire alert",
  "state": "pending",
  "message": "Fire has broke out",
  "location": "Parking",
  "created_at": "2021-05-14T09:26:14.823Z",
  "updated_at": "2021-05-14T09:26:14.823Z"
}

Definition

Key	Type	Optional	Description
id	integer	no
audience_id	integer	no	Audience the alert is sent to
type	string	no	One of available alert types
state	enum: `['pending', 'accepted', 'rejected']`	no
message	string	no	Content of message sent to recipients
location	string	yes
created_at	datetime	no	Time of creation
updated_at	datetime	no	Time of last update

AlertPayload model

Key	Type	Description
audience_id	integer[]	ID of audience that should receive the alert
type	string	Must match available alert types
message	string	Content of message sent to recipients
location	string

Alert model#

Example#

Definition#

AlertPayload model#

Alert model

Example

Definition

AlertPayload model