Create an alert

post

https://api.hcssapps.com/safety/v2/alerts

Creates an alert from the request body

For help with authorization, please visit https://developer.hcssapps.com/getting-started/request-tokens

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The request body

This is the same as an ApiAlert just without the ID

string

The Email to send the alert to

phoneNumber

string

The phone number to send the alert to

firstName

string

required

The first name of the person receiving the alert

lastName

string

required

The last name of the person receiving the alert

providerId

uuid

The id of provider who will send the message

businessUnitId

uuid

required

The business unit that the alert belongs to

carrierAddressOverride

string

Carrier address override if needed (SMS)

nearMiss

object

Near miss settings alert property

incidents

object

Incident settings alert property

inspections

object

Inspection settings alert property

observations

object

Observation settings alert property

jobs

object

Jobs settings alert property

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

Bad Request. This typically means one or more request validation errors occurred.
Check the response body for details.
For more help troubleshooting, please see https://dev-developer.hcssapps.com/getting-started/troubleshoot-bad-request

409

Conflict

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

200Alert created successfully