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

Was this page helpful?

Still looking for help? You can also search the Losant Forums or submit your question there.