POST api/SocialDriver/TelemetryAlert

Create a Telemetry Alert

Request Information

URI Parameters

None.

Body Parameters

A CreatePatchTelemetryAlertRequest

CreateTelemetryAlertRequest
NameDescriptionTypeAdditional information
ServiceId

The service id to monitor the alert on

unsigned integer

None.

AlertType

The type of alert to setup

AlertNotificationTypeEnum

None.

PushNotificationEnabled

If you want mobile push notifications sent on alert

boolean

None.

InboxMessageEnabled

If you want an inbox message sent on alert

boolean

None.

EmailEnabled

If you want emails sent on alert

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "ServiceId": 1,
  "AlertType": 0,
  "PushNotificationEnabled": true,
  "InboxMessageEnabled": true,
  "EmailEnabled": true
}

application/xml, text/xml

Sample:
<CreateTelemetryAlertRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ServiceId>1</ServiceId>
  <AlertType>Heartbeat_Voltage</AlertType>
  <PushNotificationEnabled>true</PushNotificationEnabled>
  <InboxMessageEnabled>true</InboxMessageEnabled>
  <EmailEnabled>true</EmailEnabled>
</CreateTelemetryAlertRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The id of the alert created

unsigned integer

Response Formats

application/json, text/json

Sample:
1

application/xml, text/xml

Sample:
<unsignedLong>1</unsignedLong>