Instance Notification Rule Actions

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

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

Delete

Deletes a notification rule

Method And Url

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

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.bounded, all.User, all.User.bounded, instanceNotificationRule.*, or instanceNotificationRule.delete.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec7417ae143cd83dc4a96
NOTIFICATION_RULE_ID	ID associated with the notification rule	575ec7417ae143cd83dc4a95

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 DELETE \
    https://api.losant.com/instances/INSTANCE_ID/notification-rules/NOTIFICATION_RULE_ID

Successful Responses

Code	Type	Description
200	Success	If notification rule was successfully deleted

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if notification rule was not found

Evaluate

Queues the evaluation of a notification rule

Method And Url

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

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.bounded, all.User, all.User.bounded, instanceNotificationRule.*, or instanceNotificationRule.evaluate.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec7417ae143cd83dc4a96
NOTIFICATION_RULE_ID	ID associated with the notification rule	575ec7417ae143cd83dc4a95

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 Evaluation Options schema. For example, the following would be a valid body for this request:

{
  "ignoreFrequencyCheck": true
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"ignoreFrequencyCheck":true}' \
    https://api.losant.com/instances/INSTANCE_ID/notification-rules/NOTIFICATION_RULE_ID/evaluate

Successful Responses

Code	Type	Description
202	Job Enqueued API Result	If the evaluation was successfully queued

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if notification rule was not found

Get

Retrieves information on a notification rule

Method And Url

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

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.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceNotificationRule.*, or instanceNotificationRule.get.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec7417ae143cd83dc4a96
NOTIFICATION_RULE_ID	ID associated with the notification rule	575ec7417ae143cd83dc4a95

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/NOTIFICATION_RULE_ID

Successful Responses

Code	Type	Description
200	Notification Rule	Notification rule information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if notification rule was not found

Logs

Retrieves information on notification rule deliveries

Method And Url

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

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.bounded, all.User, all.User.bounded, instanceNotificationRule.*, or instanceNotificationRule.logs.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec7417ae143cd83dc4a96
NOTIFICATION_RULE_ID	ID associated with the notification rule	575ec7417ae143cd83dc4a95

Request Query Parameters

Name	Required	Description	Default	Example
limit	N	Max log entries to return (ordered by time descending)	1	limit=10
since	N	Look for log entries since this time (ms since epoch)		since=1465790400000

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/NOTIFICATION_RULE_ID/logs

Successful Responses

Code	Type	Description
200	Notification Rule Delivery Logs	Notification delivery information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if notification rule was not found

Patch

Updates information about a notification rule

Method And Url

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

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.bounded, all.User, all.User.bounded, instanceNotificationRule.*, or instanceNotificationRule.patch.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec7417ae143cd83dc4a96
NOTIFICATION_RULE_ID	ID associated with the notification rule	575ec7417ae143cd83dc4a95

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 Patch schema. For example, the following would be a valid body for this request:

{
  "name": "My Updated Notification Rule",
  "enabled": false
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"name":"My Updated Notification Rule","enabled":false}' \
    https://api.losant.com/instances/INSTANCE_ID/notification-rules/NOTIFICATION_RULE_ID

Successful Responses

Code	Type	Description
200	Notification Rule	Updated notification rule information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if notification rule was not found

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:{} 3 keys
▶
type:{} 1 key
▶
message:{} 1 key
▶
validationErrors:{} 2 keys

Error Example

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

Job Enqueued API Result

Schema for the result of a job being queued

Job Enqueued API Result Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
jobQueued:{} 2 keys
▶
jobId:{} 2 keys
▶
success:{} 2 keys

Job Enqueued API Result Example

▶
(root){} 3 keys
jobQueued:true
jobId:"clnHvJbyVkOWAZwYAwLP4"
success:true

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:{} 19 keys
▶
id:{} 2 keys
▶
notificationRuleId:{} 2 keys
▶
ownerId:{} 2 keys
▶
ownerType:{} 2 keys
▶
instanceId:{} 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 Delivery Logs

Schema for a set of Notification Rule delivery logs

Notification Rule Delivery Logs Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"array"
▶
items:{} 2 keys

Notification Rule Delivery Logs Example

▶
(root)[] 1 item
▶
0:{} 13 keys

Notification Rule Evaluation Options

Schema for evaluation options for a notification rule

Notification Rule Evaluation Options Schema

▶
(root){} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 1 key
▶
ignoreFrequencyCheck:{} 1 key
additionalProperties:false

Notification Rule Evaluation Options Example

▶
(root){} 1 key
ignoreFrequencyCheck:true

Notification Rule Patch

Schema for the body of a notification rule modification request

Notification Rule Patch Schema

▶
(root){} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 7 keys
▶
targetQueryJson:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
enabled:{} 1 key
▶
callbackUrl:{} 1 key
▶
emailConfig:{} 1 key
▶
ruleConfig:{} 4 keys
additionalProperties:false

Notification Rule Patch Example

▶
(root){} 2 keys
name:"My Updated Notification Rule"
enabled:false

Success

Schema for reporting a successful operation

Success Schema

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

Success Example

▶
(root){} 1 key
success:true