Instance Notification Rules Actions

https://api.losant.com/instances/INSTANCE_ID/notification-rules

Below are the various requests that can be performed against the Instance Notification Rules resource, as well as the expected parameters and the potential responses.

Get

Returns the notification rules for an instance

Method And Url

GET https://api.losant.com/instances/INSTANCE_ID/notification-rules

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.Instance.read, all.User, all.User.read, instanceNotificationRules.*, or instanceNotificationRules.get.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec7417ae143cd83dc4a96

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated	name	sortField=name
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	asc	sortDirection=asc
page	N	Which page of results to return	0	page=0
perPage	N	How many items to return per page	100	perPage=10
filterField	N	Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name		filterField=key
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=my*rule

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/instances/INSTANCE_ID/notification-rules

Successful Responses

Code	Type	Description
200	Notification Rules	Collection of notification rules

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Post

Create a new notification rule for an instance

Method And Url

POST https://api.losant.com/instances/INSTANCE_ID/notification-rules

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.User, instanceNotificationRules.*, or instanceNotificationRules.post.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec7417ae143cd83dc4a96

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Notification Rule Post schema. For example, the following would be a valid body for this request:

{
  "name": "My New Notification Rule",
  "targetType": "organization",
  "targetQueryJson": "{}",
  "emailConfig": {
    "subjectTemplate": "Limit Exceeded",
    "bodyTemplate": "Org has exceeded its payload limit",
    "sendToTarget": "admins"
  },
  "ruleConfig": {
    "ruleType": "payloadUsage",
    "thresholdType": "percentOfLimit",
    "threshold": 100
  }
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"name":"My New Notification Rule","targetType":"organization","targetQueryJson":"{}","emailConfig":{"subjectTemplate":"Limit Exceeded","bodyTemplate":"Org has exceeded its payload limit","sendToTarget":"admins"},"ruleConfig":{"ruleType":"payloadUsage","thresholdType":"percentOfLimit","threshold":100}}' \
    https://api.losant.com/instances/INSTANCE_ID/notification-rules

Successful Responses

Code	Type	Description
201	Notification Rule	The successfully created notification rule

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Schemas

Error

Schema for errors returned by the API

Error Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
type:{} 1 key
▶
message:{} 1 key

Error Example

▶
root:{} 2 keys
type:"NotFound"
message:"Application was not found"

Notification Rule

Schema for a single notification rule

Notification Rule Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 18 keys
▶
id:{} 2 keys
▶
notificationRuleId:{} 2 keys
▶
ownerId:{} 2 keys
▶
ownerType:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
createdById:{} 2 keys
▶
createdByType:{} 2 keys
▶
lastUpdatedById:{} 2 keys
▶
lastUpdatedByType:{} 2 keys
▶
targetType:{} 2 keys
▶
targetQueryJson:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
enabled:{} 1 key
▶
callbackUrl:{} 3 keys
▶
emailConfig:{} 4 keys
▶
ruleConfig:{} 4 keys

Notification Rule Example

▶
root:{} 16 keys
id:"585ec7417ae143cd83dc4a95"
notificationRuleId:"585ec7417ae143cd83dc4a95"
ownerId:"60106426dc03c6aad06560ba"
ownerType:"instance"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
createdById:"575ed70c7ae143cd83dc4aa9"
createdByType:"user"
lastUpdatedById:"575ed70c7ae143cd83dc4aa9"
lastUpdatedByType:"user"
targetType:"organization"
targetQueryJson:"{}"
name:"My Notification Rule"
enabled:true
▶
emailConfig:{} 5 keys
▶
ruleConfig:{} 4 keys

Notification Rule Post

Schema for the body of a notification rule creation request

Notification Rule Post Schema

▶
root:{} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 8 keys
▶
targetType:{} 2 keys
▶
targetQueryJson:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
enabled:{} 1 key
▶
callbackUrl:{} 1 key
▶
emailConfig:{} 1 key
▶
ruleConfig:{} 4 keys
additionalProperties:false
▶
required:[] 4 items

Notification Rule Post Example

▶
root:{} 5 keys
name:"My New Notification Rule"
targetType:"organization"
targetQueryJson:"{}"
▶
emailConfig:{} 3 keys
▶
ruleConfig:{} 3 keys

Notification Rules

Schema for a collection of notification rules

Notification Rules Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 11 keys
▶
items:{} 2 keys
▶
count:{} 1 key
▶
totalCount:{} 1 key
▶
perPage:{} 1 key
▶
page:{} 1 key
▶
filter:{} 1 key
▶
filterField:{} 1 key
▶
sortField:{} 1 key
▶
sortDirection:{} 2 keys
▶
ownerId:{} 2 keys
▶
ownerType:{} 2 keys

Notification Rules Example

▶
root:{} 9 keys
▶
items:[] 1 item
count:1
totalCount:4
perPage:1
page:0
sortField:"name"
sortDirection:"asc"
ownerId:"60106426dc03c6aad06560ba"
ownerType:"instance"