losant_rest 1.20.1 → 1.21.0

data/docs/_schemas.md

@@ -244,6 +244,12 @@
 *   [Notebook Patch](#notebook-patch)
 *   [Notebook Post](#notebook-post)
 *   [Notebooks](#notebooks)
+*   [Notification Rule](#notification-rule)
+*   [Notification Rule Delivery Logs](#notification-rule-delivery-logs)
+*   [Notification Rule Evaluation Options](#notification-rule-evaluation-options)
+*   [Notification Rule Patch](#notification-rule-patch)
+*   [Notification Rule Post](#notification-rule-post)
+*   [Notification Rules](#notification-rules)
 *   [Organization](#organization)
 *   [Organization Invitation](#organization-invitation)
 *   [Organization Invitation Action](#organization-invitation-action)
@@ -13451,6 +13457,15 @@ Schema for the body of an API Token creation request
               "instanceCustomNode.delete",
               "instanceCustomNode.errors",
               "instanceCustomNode.stats",
+              "instanceNotificationRules.*",
+              "instanceNotificationRules.get",
+              "instanceNotificationRules.post",
+              "instanceNotificationRule.*",
+              "instanceNotificationRule.get",
+              "instanceNotificationRule.patch",
+              "instanceNotificationRule.delete",
+              "instanceNotificationRule.evaluate",
+              "instanceNotificationRule.logs",
               "instanceSandbox.*",
               "instanceSandbox.get",
               "instanceSandbox.delete",
@@ -23962,18 +23977,57 @@ Results of a search of an application's resources
         "type": "string"
       },
       "metadata": {
-        "type": "object"
-      },
-      "viewType": {
-        "type": "string"
+        "type": "object",
+        "properties": {
+          "descriptor": {
+            "type": "string"
+          },
+          "parentDirectory": {
+            "type": "string"
+          },
+          "contentType": {
+            "type": "string"
+          }
+        }
       },
       "version": {
         "type": "string"
       },
+      "viewType": {
+        "type": "string",
+        "enum": [
+          "layout",
+          "page",
+          "component"
+        ]
+      },
+      "flowClass": {
+        "type": "string",
+        "enum": [
+          "standalone",
+          "gateway",
+          "peripheral",
+          "floating",
+          "edgeCompute",
+          "system",
+          "embedded"
+        ]
+      },
+      "deviceClass": {
+        "type": "string",
+        "enum": [
+          "cloud",
+          "edge",
+          "embedded",
+          "experience",
+          "customNode"
+        ]
+      },
       "_type": {
         "type": "string",
         "enum": [
           "applicationApiToken",
+          "credential",
           "dashboard",
           "dataTable",
           "deviceRecipe",
@@ -23989,8 +24043,9 @@ Results of a search of an application's resources
           "file",
           "flow",
           "integration",
-          "webhook",
-          "notebook"
+          "notebook",
+          "resourceJob",
+          "webhook"
         ]
       }
     },
@@ -27316,6 +27371,10 @@ The body of an credential linked resources response
                                 }
                               },
                               "maxItems": 100
+                            },
+                            "configName": {
+                              "type": "string",
+                              "maxLength": 1024
                             }
                           },
                           "additionalProperties": false
@@ -30443,6 +30502,10 @@ The body of an credential linked resources response
                                     }
                                   },
                                   "maxItems": 100
+                                },
+                                "configName": {
+                                  "type": "string",
+                                  "maxLength": 1024
                                 }
                               },
                               "additionalProperties": false
@@ -33479,6 +33542,10 @@ The body of an credential linked resources response
                                     }
                                   },
                                   "maxItems": 100
+                                },
+                                "configName": {
+                                  "type": "string",
+                                  "maxLength": 1024
                                 }
                               },
                               "additionalProperties": false
@@ -84870,9 +84937,14 @@ Schema for a single Experience Endpoint
       "enum": [
         "public",
         "authenticated",
-        "group"
+        "group",
+        "device"
       ]
     },
+    "deviceIdTemplate": {
+      "type": "string",
+      "maxLength": 255
+    },
     "endpointTags": {
       "type": "object",
       "patternProperties": {
@@ -85031,9 +85103,14 @@ Schema for the body of an Experience Endpoint modification request
       "enum": [
         "public",
         "authenticated",
-        "group"
+        "group",
+        "device"
       ]
     },
+    "deviceIdTemplate": {
+      "type": "string",
+      "maxLength": 255
+    },
     "endpointTags": {
       "type": "object",
       "patternProperties": {
@@ -85173,9 +85250,14 @@ Schema for the body of an Experience Endpoint creation request
       "enum": [
         "public",
         "authenticated",
-        "group"
+        "group",
+        "device"
       ]
     },
+    "deviceIdTemplate": {
+      "type": "string",
+      "maxLength": 255
+    },
     "endpointTags": {
       "type": "object",
       "patternProperties": {
@@ -85427,9 +85509,14 @@ Schema for a collection of Experience Endpoints
             "enum": [
               "public",
               "authenticated",
-              "group"
+              "group",
+              "device"
             ]
           },
+          "deviceIdTemplate": {
+            "type": "string",
+            "maxLength": 255
+          },
           "endpointTags": {
             "type": "object",
             "patternProperties": {
@@ -86464,9 +86551,14 @@ The body of an experience linked resources response
                 "enum": [
                   "public",
                   "authenticated",
-                  "group"
+                  "group",
+                  "device"
                 ]
               },
+              "deviceIdTemplate": {
+                "type": "string",
+                "maxLength": 255
+              },
               "endpointTags": {
                 "type": "object",
                 "patternProperties": {
@@ -86999,6 +87091,10 @@ The body of an experience linked resources response
                                 }
                               },
                               "maxItems": 100
+                            },
+                            "configName": {
+                              "type": "string",
+                              "maxLength": 1024
                             }
                           },
                           "additionalProperties": false
@@ -90126,6 +90222,10 @@ The body of an experience linked resources response
                                     }
                                   },
                                   "maxItems": 100
+                                },
+                                "configName": {
+                                  "type": "string",
+                                  "maxLength": 1024
                                 }
                               },
                               "additionalProperties": false
@@ -93162,6 +93262,10 @@ The body of an experience linked resources response
                                     }
                                   },
                                   "maxItems": 100
+                                },
+                                "configName": {
+                                  "type": "string",
+                                  "maxLength": 1024
                                 }
                               },
                               "additionalProperties": false
@@ -98630,6 +98734,10 @@ Schema for a single Workflow
                       }
                     },
                     "maxItems": 100
+                  },
+                  "configName": {
+                    "type": "string",
+                    "maxLength": 1024
                   }
                 },
                 "additionalProperties": false
@@ -101900,6 +102008,10 @@ Schema for the body of a Workflow modification request
                       }
                     },
                     "maxItems": 100
+                  },
+                  "configName": {
+                    "type": "string",
+                    "maxLength": 1024
                   }
                 },
                 "additionalProperties": false
@@ -104923,6 +105035,10 @@ Schema for the body of a Workflow creation request
                       }
                     },
                     "maxItems": 100
+                  },
+                  "configName": {
+                    "type": "string",
+                    "maxLength": 1024
                   }
                 },
                 "additionalProperties": false
@@ -108218,6 +108334,10 @@ Schema for a single Workflow Version
                           }
                         },
                         "maxItems": 100
+                      },
+                      "configName": {
+                        "type": "string",
+                        "maxLength": 1024
                       }
                     },
                     "additionalProperties": false
@@ -111254,6 +111374,10 @@ Schema for a single Workflow Version
                           }
                         },
                         "maxItems": 100
+                      },
+                      "configName": {
+                        "type": "string",
+                        "maxLength": 1024
                       }
                     },
                     "additionalProperties": false
@@ -114001,6 +114125,10 @@ Schema for the body of a Workflow Version creation request
                       }
                     },
                     "maxItems": 100
+                  },
+                  "configName": {
+                    "type": "string",
+                    "maxLength": 1024
                   }
                 },
                 "additionalProperties": false
@@ -117063,6 +117191,10 @@ Schema for a collection of Workflow Versions
                                 }
                               },
                               "maxItems": 100
+                            },
+                            "configName": {
+                              "type": "string",
+                              "maxLength": 1024
                             }
                           },
                           "additionalProperties": false
@@ -120099,6 +120231,10 @@ Schema for a collection of Workflow Versions
                                 }
                               },
                               "maxItems": 100
+                            },
+                            "configName": {
+                              "type": "string",
+                              "maxLength": 1024
                             }
                           },
                           "additionalProperties": false
@@ -124075,6 +124211,10 @@ Schema for a collection of Workflows
                             }
                           },
                           "maxItems": 100
+                        },
+                        "configName": {
+                          "type": "string",
+                          "maxLength": 1024
                         }
                       },
                       "additionalProperties": false
@@ -127222,6 +127362,10 @@ Schema for the body of a workflow import request
                             }
                           },
                           "maxItems": 100
+                        },
+                        "configName": {
+                          "type": "string",
+                          "maxLength": 1024
                         }
                       },
                       "additionalProperties": false
@@ -130247,6 +130391,10 @@ Schema for the body of a workflow import request
                             }
                           },
                           "maxItems": 100
+                        },
+                        "configName": {
+                          "type": "string",
+                          "maxLength": 1024
                         }
                       },
                       "additionalProperties": false
@@ -133346,6 +133494,10 @@ Schema for the result of a workflow import request
                             }
                           },
                           "maxItems": 100
+                        },
+                        "configName": {
+                          "type": "string",
+                          "maxLength": 1024
                         }
                       },
                       "additionalProperties": false
@@ -136422,6 +136574,10 @@ Schema for the result of a workflow import request
                                 }
                               },
                               "maxItems": 100
+                            },
+                            "configName": {
+                              "type": "string",
+                              "maxLength": 1024
                             }
                           },
                           "additionalProperties": false
@@ -139458,6 +139614,10 @@ Schema for the result of a workflow import request
                                 }
                               },
                               "maxItems": 100
+                            },
+                            "configName": {
+                              "type": "string",
+                              "maxLength": 1024
                             }
                           },
                           "additionalProperties": false
@@ -142320,6 +142480,15 @@ Schema for the body of a Github login request
               "instanceCustomNode.delete",
               "instanceCustomNode.errors",
               "instanceCustomNode.stats",
+              "instanceNotificationRules.*",
+              "instanceNotificationRules.get",
+              "instanceNotificationRules.post",
+              "instanceNotificationRule.*",
+              "instanceNotificationRule.get",
+              "instanceNotificationRule.patch",
+              "instanceNotificationRule.delete",
+              "instanceNotificationRule.evaluate",
+              "instanceNotificationRule.logs",
               "instanceSandbox.*",
               "instanceSandbox.get",
               "instanceSandbox.delete",
@@ -144110,6 +144279,15 @@ Schema for a single Instance
         "organization": {
           "type": "integer"
         },
+        "instanceApiToken": {
+          "type": "integer"
+        },
+        "instanceNotificationRule": {
+          "type": "integer"
+        },
+        "instanceCustomNode": {
+          "type": "integer"
+        },
         "apitoken": {
           "type": "integer"
         },
@@ -144480,7 +144658,8 @@ Schema for a single Instance Audit Log entry
         "Organization",
         "ApiToken",
         "User",
-        "InstanceCustomNode"
+        "InstanceCustomNode",
+        "NotificationRule"
       ]
     },
     "primaryTargetName": {
@@ -144601,7 +144780,8 @@ Schema for the filter of an instance audit log query
               "Organization",
               "ApiToken",
               "User",
-              "InstanceCustomNode"
+              "InstanceCustomNode",
+              "NotificationRule"
             ]
           },
           "name": {
@@ -147840,6 +148020,10 @@ Schema for the body of an Organization owned by an instance
       "type": "string",
       "pattern": "^[A-Fa-f\\d]{24}$"
     },
+    "orgId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
     "instanceId": {
       "type": "string",
       "pattern": "^[A-Fa-f\\d]{24}$"
@@ -148385,13 +148569,106 @@ Schema for the body of an Organization owned by an instance
 
 ```json
 {
+  "creationDate": "2022-10-26T19:27:42.736Z",
+  "lastUpdated": "2024-10-24T17:04:32.009Z",
   "name": "My Org",
   "id": "60106426dc03c6aad06540bb",
+  "orgId": "60106426dc03c6aad06540bb",
   "instanceId": "60106426dc03c6aad06560ba",
+  "description": "My Org Description",
+  "iconColor": "#057180",
   "limits": {
-    "member": 500
+    "apitoken": 1000,
+    "application": 100,
+    "applicationcertificate": 1000,
+    "applicationcertificateauthority": 1000,
+    "applicationkey": 1000,
+    "credential": 100,
+    "dashboard": 100,
+    "datatable": 100,
+    "device": 1000,
+    "devicerecipe": 1000,
+    "experiencedomain": 100,
+    "experienceendpoint": 500,
+    "experienceslug": 100,
+    "experienceversion": 1000,
+    "experienceview": 500,
+    "experiencegroup": 100,
+    "experienceuser": 1000,
+    "file": 1000,
+    "flow": 1000,
+    "integration": 50,
+    "notebook": 100,
+    "resourcejob": 100,
+    "webhook": 1000,
+    "dataTTL": 15552000,
+    "member": 100,
+    "payload": 75000000,
+    "storage": 1073741824,
+    "notebookMinutesPerRun": 60,
+    "notebookMinutesPerMonth": 930,
+    "notebookInParallel": 5,
+    "systemInterval": 5,
+    "experienceFlowSlots": 30,
+    "applicationFlowSlots": 350
   },
-  "auditLogEnabled": true
+  "summary": {
+    "apiTokenCount": 0,
+    "appCount": 2,
+    "certificateAuthorityCount": 0,
+    "certificateCount": 0,
+    "credentialCount": 4,
+    "dashCount": 2,
+    "dataTableCount": 1,
+    "deviceCount": 6,
+    "deviceRecipeCount": 1,
+    "experienceDomainCount": 0,
+    "experienceEndpointCount": 10,
+    "experienceGroupCount": 4,
+    "experienceSlugCount": 0,
+    "experienceUserCount": 2,
+    "experienceVersionCount": 4,
+    "experienceViewCount": 9,
+    "fileCount": 0,
+    "flowCount": 30,
+    "integrationCount": 6,
+    "notebookCount": 0,
+    "resourceJobCount": 5,
+    "keyCount": 17,
+    "memberCount": 1,
+    "payloadCount": {
+      "integration": {
+        "integration.flow": 67679
+      }
+    },
+    "storageStats": {
+      "count": 0,
+      "size": 0
+    },
+    "notebookStats": {
+      "awaitingCompletion": 0,
+      "minutesThisPeriod": 0,
+      "runsThisPeriod": 0
+    },
+    "webhookCount": 0
+  },
+  "whitelistedEmailDomains": [],
+  "auditLogEnabled": false,
+  "disabledAt": false,
+  "isReadOnly": false,
+  "tags": [
+    {
+      "key": "my",
+      "value": "tag"
+    }
+  ],
+  "mfaMode": "notRequired",
+  "banner": {
+    "message": "A banner message",
+    "level": "warning"
+  },
+  "currentPeriodStart": "2023-01-01T00:00:00.000Z",
+  "currentPeriodEnd": "2023-01-31T11:59:59.999Z"
 }
 ```
 
@@ -149533,6 +149810,10 @@ Schema for a collection of Organizations within an instance
             "type": "string",
             "pattern": "^[A-Fa-f\\d]{24}$"
           },
+          "orgId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
           "instanceId": {
             "type": "string",
             "pattern": "^[A-Fa-f\\d]{24}$"
@@ -150118,13 +150399,106 @@ Schema for a collection of Organizations within an instance
 {
   "items": [
     {
+      "creationDate": "2022-10-26T19:27:42.736Z",
+      "lastUpdated": "2024-10-24T17:04:32.009Z",
       "name": "My Org",
       "id": "60106426dc03c6aad06540bb",
+      "orgId": "60106426dc03c6aad06540bb",
       "instanceId": "60106426dc03c6aad06560ba",
+      "description": "My Org Description",
+      "iconColor": "#057180",
       "limits": {
-        "member": 500
+        "apitoken": 1000,
+        "application": 100,
+        "applicationcertificate": 1000,
+        "applicationcertificateauthority": 1000,
+        "applicationkey": 1000,
+        "credential": 100,
+        "dashboard": 100,
+        "datatable": 100,
+        "device": 1000,
+        "devicerecipe": 1000,
+        "experiencedomain": 100,
+        "experienceendpoint": 500,
+        "experienceslug": 100,
+        "experienceversion": 1000,
+        "experienceview": 500,
+        "experiencegroup": 100,
+        "experienceuser": 1000,
+        "file": 1000,
+        "flow": 1000,
+        "integration": 50,
+        "notebook": 100,
+        "resourcejob": 100,
+        "webhook": 1000,
+        "dataTTL": 15552000,
+        "member": 100,
+        "payload": 75000000,
+        "storage": 1073741824,
+        "notebookMinutesPerRun": 60,
+        "notebookMinutesPerMonth": 930,
+        "notebookInParallel": 5,
+        "systemInterval": 5,
+        "experienceFlowSlots": 30,
+        "applicationFlowSlots": 350
+      },
+      "summary": {
+        "apiTokenCount": 0,
+        "appCount": 2,
+        "certificateAuthorityCount": 0,
+        "certificateCount": 0,
+        "credentialCount": 4,
+        "dashCount": 2,
+        "dataTableCount": 1,
+        "deviceCount": 6,
+        "deviceRecipeCount": 1,
+        "experienceDomainCount": 0,
+        "experienceEndpointCount": 10,
+        "experienceGroupCount": 4,
+        "experienceSlugCount": 0,
+        "experienceUserCount": 2,
+        "experienceVersionCount": 4,
+        "experienceViewCount": 9,
+        "fileCount": 0,
+        "flowCount": 30,
+        "integrationCount": 6,
+        "notebookCount": 0,
+        "resourceJobCount": 5,
+        "keyCount": 17,
+        "memberCount": 1,
+        "payloadCount": {
+          "integration": {
+            "integration.flow": 67679
+          }
+        },
+        "storageStats": {
+          "count": 0,
+          "size": 0
+        },
+        "notebookStats": {
+          "awaitingCompletion": 0,
+          "minutesThisPeriod": 0,
+          "runsThisPeriod": 0
+        },
+        "webhookCount": 0
+      },
+      "whitelistedEmailDomains": [],
+      "auditLogEnabled": false,
+      "disabledAt": false,
+      "isReadOnly": false,
+      "tags": [
+        {
+          "key": "my",
+          "value": "tag"
+        }
+      ],
+      "mfaMode": "notRequired",
+      "banner": {
+        "message": "A banner message",
+        "level": "warning"
       },
-      "auditLogEnabled": true
+      "currentPeriodStart": "2023-01-01T00:00:00.000Z",
+      "currentPeriodEnd": "2023-01-31T11:59:59.999Z"
     }
   ],
   "count": 1,
@@ -151775,6 +152149,15 @@ Schema for a collection of Instances
               "organization": {
                 "type": "integer"
               },
+              "instanceApiToken": {
+                "type": "integer"
+              },
+              "instanceNotificationRule": {
+                "type": "integer"
+              },
+              "instanceCustomNode": {
+                "type": "integer"
+              },
               "apitoken": {
                 "type": "integer"
               },
@@ -161976,6 +162359,992 @@ Schema for a collection of Notebooks
 
 <br/>
 
+## Notification Rule
+
+Schema for a single notification rule
+
+### <a name="notification-rule-schema"></a> Schema
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "notificationRuleId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "ownerId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "ownerType": {
+      "type": "string",
+      "enum": [
+        "instance"
+      ]
+    },
+    "creationDate": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "lastUpdated": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "createdById": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "createdByType": {
+      "type": "string",
+      "enum": [
+        "apiToken",
+        "user"
+      ]
+    },
+    "lastUpdatedById": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "lastUpdatedByType": {
+      "type": "string",
+      "enum": [
+        "apiToken",
+        "user"
+      ]
+    },
+    "targetType": {
+      "type": "string",
+      "enum": [
+        "organization"
+      ]
+    },
+    "targetQueryJson": {
+      "type": "string",
+      "maxLength": 8192
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 32767
+    },
+    "enabled": {
+      "type": "boolean"
+    },
+    "callbackUrl": {
+      "type": "string",
+      "format": "uri",
+      "maxLength": 1024
+    },
+    "emailConfig": {
+      "type": "object",
+      "properties": {
+        "subjectTemplate": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1024
+        },
+        "bodyTemplate": {
+          "type": "string",
+          "maxLength": 32767
+        },
+        "sendToTarget": {
+          "type": "string",
+          "enum": [
+            "admins",
+            "members",
+            "none"
+          ]
+        },
+        "sendToOwner": {
+          "type": "string",
+          "enum": [
+            "admins",
+            "members",
+            "none"
+          ]
+        },
+        "sendToAddresses": {
+          "type": "array",
+          "maxItems": 10,
+          "items": {
+            "type": "string",
+            "format": "email",
+            "maxLength": 1024
+          }
+        }
+      },
+      "required": [
+        "subjectTemplate",
+        "bodyTemplate"
+      ],
+      "additionalProperties": false
+    },
+    "ruleConfig": {
+      "type": "object",
+      "properties": {
+        "ruleType": {
+          "type": "string",
+          "enum": [
+            "payloadUsage",
+            "notebookMinuteUsage"
+          ]
+        },
+        "thresholdType": {
+          "type": "string",
+          "enum": [
+            "percentOfLimit"
+          ]
+        },
+        "threshold": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 1000
+        },
+        "maxFrequency": {
+          "type": "string",
+          "enum": [
+            "billingCycle",
+            "daily"
+          ]
+        }
+      },
+      "required": [
+        "ruleType",
+        "thresholdType",
+        "threshold"
+      ],
+      "additionalProperties": false
+    }
+  }
+}
+```
+### <a name="notification-rule-example"></a> Example
+
+```json
+{
+  "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": {
+    "subjectTemplate": "Limit Exceeded",
+    "bodyTemplate": "Org has exceeded its payload limit",
+    "sendToTarget": "admins",
+    "sendToOwner": "none",
+    "sendToAddresses": []
+  },
+  "ruleConfig": {
+    "ruleType": "payloadUsage",
+    "thresholdType": "percentOfLimit",
+    "threshold": 100,
+    "maxFrequency": "billingCycle"
+  }
+}
+```
+
+<br/>
+
+## Notification Rule Delivery Logs
+
+Schema for a set of Notification Rule delivery logs
+
+### <a name="notification-rule-delivery-logs-schema"></a> Schema
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "array",
+  "items": {
+    "type": "object",
+    "properties": {
+      "id": {
+        "type": "string",
+        "pattern": "^[A-Fa-f\\d]{24}$"
+      },
+      "notificationRuleDeliveryId": {
+        "type": "string",
+        "pattern": "^[A-Fa-f\\d]{24}$"
+      },
+      "notificationRuleId": {
+        "type": "string",
+        "pattern": "^[A-Fa-f\\d]{24}$"
+      },
+      "ownerId": {
+        "type": "string",
+        "pattern": "^[A-Fa-f\\d]{24}$"
+      },
+      "ownerType": {
+        "type": "string",
+        "enum": [
+          "instance"
+        ]
+      },
+      "requestedById": {
+        "type": "string",
+        "pattern": "^[A-Fa-f\\d]{24}$"
+      },
+      "requestedByType": {
+        "type": "string",
+        "enum": [
+          "user",
+          "apiToken",
+          "system"
+        ]
+      },
+      "sentAt": {
+        "type": "string",
+        "format": "date-time"
+      },
+      "targetType": {
+        "type": "string",
+        "enum": [
+          "organization"
+        ]
+      },
+      "targetId": {
+        "type": "string",
+        "pattern": "^[A-Fa-f\\d]{24}$"
+      },
+      "targetName": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 255
+      },
+      "callbackUrl": {
+        "type": "string",
+        "format": "uri",
+        "maxLength": 1024
+      },
+      "email": {
+        "type": "object",
+        "properties": {
+          "subject": {
+            "type": "string"
+          },
+          "body": {
+            "type": "string"
+          },
+          "addresses": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "format": "email",
+              "maxLength": 1024
+            }
+          }
+        }
+      },
+      "evaluation": {
+        "type": "object",
+        "properties": {
+          "value": {
+            "type": "number"
+          },
+          "limit": {
+            "type": "number"
+          },
+          "ruleType": {
+            "type": "string",
+            "enum": [
+              "payloadUsage",
+              "notebookMinuteUsage"
+            ]
+          },
+          "thresholdType": {
+            "type": "string",
+            "enum": [
+              "percentOfLimit"
+            ]
+          },
+          "threshold": {
+            "type": "number",
+            "minimum": 0,
+            "maximum": 1000
+          },
+          "maxFrequency": {
+            "type": "string",
+            "enum": [
+              "billingCycle",
+              "daily",
+              "unlimited"
+            ]
+          }
+        }
+      }
+    }
+  }
+}
+```
+### <a name="notification-rule-delivery-logs-example"></a> Example
+
+```json
+[
+  {
+    "id": "585ec7417ae143cd83dc4a85",
+    "notificationRuleDeliveryId": "585ec7417ae143cd83dc4a85",
+    "notificationRuleId": "585ec7417ae143cd83dc4a95",
+    "ownerId": "60106426dc03c6aad06560ba",
+    "ownerType": "instance",
+    "requestedById": "000000000000000000000000",
+    "requestedByType": "system",
+    "sentAt": "2016-06-13T04:00:00.000Z",
+    "targetType": "organization",
+    "targetId": "585ec7417ae143cd83dc4a75",
+    "targetName": "My Org",
+    "email": {
+      "subject": "Limit Exceeded",
+      "body": "Org has exceeded its payload limit",
+      "addresses": [
+        "alice@exmaple.com"
+      ]
+    },
+    "evaluation": {
+      "ruleType": "payloadUsage",
+      "thresholdType": "percentOfLimit",
+      "threshold": 100,
+      "maxFrequency": "billingCycle",
+      "value": 1001040,
+      "limit": 1000000
+    }
+  }
+]
+```
+
+<br/>
+
+## Notification Rule Evaluation Options
+
+Schema for evaluation options for a notification rule
+
+### <a name="notification-rule-evaluation-options-schema"></a> Schema
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "ignoreFrequencyCheck": {
+      "type": "boolean"
+    }
+  },
+  "additionalProperties": false
+}
+```
+### <a name="notification-rule-evaluation-options-example"></a> Example
+
+```json
+{
+  "ignoreFrequencyCheck": true
+}
+```
+
+<br/>
+
+## Notification Rule Patch
+
+Schema for the body of a notification rule modification request
+
+### <a name="notification-rule-patch-schema"></a> Schema
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "targetQueryJson": {
+      "type": "string",
+      "maxLength": 8192
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 32767
+    },
+    "enabled": {
+      "type": "boolean"
+    },
+    "callbackUrl": {
+      "oneOf": [
+        {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 1024
+        },
+        {
+          "type": "null"
+        },
+        {
+          "type": "string",
+          "enum": [
+            ""
+          ]
+        }
+      ]
+    },
+    "emailConfig": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "subjectTemplate": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 1024
+            },
+            "bodyTemplate": {
+              "type": "string",
+              "maxLength": 32767
+            },
+            "sendToTarget": {
+              "type": "string",
+              "enum": [
+                "admins",
+                "members",
+                "none"
+              ]
+            },
+            "sendToOwner": {
+              "type": "string",
+              "enum": [
+                "admins",
+                "members",
+                "none"
+              ]
+            },
+            "sendToAddresses": {
+              "type": "array",
+              "maxItems": 10,
+              "items": {
+                "type": "string",
+                "format": "email",
+                "maxLength": 1024
+              }
+            }
+          },
+          "required": [
+            "subjectTemplate",
+            "bodyTemplate"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "ruleConfig": {
+      "type": "object",
+      "properties": {
+        "ruleType": {
+          "type": "string",
+          "enum": [
+            "payloadUsage",
+            "notebookMinuteUsage"
+          ]
+        },
+        "thresholdType": {
+          "type": "string",
+          "enum": [
+            "percentOfLimit"
+          ]
+        },
+        "threshold": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 1000
+        },
+        "maxFrequency": {
+          "type": "string",
+          "enum": [
+            "billingCycle",
+            "daily"
+          ]
+        }
+      },
+      "required": [
+        "ruleType",
+        "thresholdType",
+        "threshold"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}
+```
+### <a name="notification-rule-patch-example"></a> Example
+
+```json
+{
+  "name": "My Updated Notification Rule",
+  "enabled": false
+}
+```
+
+<br/>
+
+## Notification Rule Post
+
+Schema for the body of a notification rule creation request
+
+### <a name="notification-rule-post-schema"></a> Schema
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "targetType": {
+      "type": "string",
+      "enum": [
+        "organization"
+      ]
+    },
+    "targetQueryJson": {
+      "type": "string",
+      "maxLength": 8192
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 32767
+    },
+    "enabled": {
+      "type": "boolean"
+    },
+    "callbackUrl": {
+      "oneOf": [
+        {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 1024
+        },
+        {
+          "type": "null"
+        },
+        {
+          "type": "string",
+          "enum": [
+            ""
+          ]
+        }
+      ]
+    },
+    "emailConfig": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "subjectTemplate": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 1024
+            },
+            "bodyTemplate": {
+              "type": "string",
+              "maxLength": 32767
+            },
+            "sendToTarget": {
+              "type": "string",
+              "enum": [
+                "admins",
+                "members",
+                "none"
+              ]
+            },
+            "sendToOwner": {
+              "type": "string",
+              "enum": [
+                "admins",
+                "members",
+                "none"
+              ]
+            },
+            "sendToAddresses": {
+              "type": "array",
+              "maxItems": 10,
+              "items": {
+                "type": "string",
+                "format": "email",
+                "maxLength": 1024
+              }
+            }
+          },
+          "required": [
+            "subjectTemplate",
+            "bodyTemplate"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "ruleConfig": {
+      "type": "object",
+      "properties": {
+        "ruleType": {
+          "type": "string",
+          "enum": [
+            "payloadUsage",
+            "notebookMinuteUsage"
+          ]
+        },
+        "thresholdType": {
+          "type": "string",
+          "enum": [
+            "percentOfLimit"
+          ]
+        },
+        "threshold": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 1000
+        },
+        "maxFrequency": {
+          "type": "string",
+          "enum": [
+            "billingCycle",
+            "daily"
+          ]
+        }
+      },
+      "required": [
+        "ruleType",
+        "thresholdType",
+        "threshold"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "targetType",
+    "targetQueryJson",
+    "name",
+    "ruleConfig"
+  ]
+}
+```
+### <a name="notification-rule-post-example"></a> Example
+
+```json
+{
+  "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
+  }
+}
+```
+
+<br/>
+
+## Notification Rules
+
+Schema for a collection of notification rules
+
+### <a name="notification-rules-schema"></a> Schema
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "items": {
+      "type": "array",
+      "items": {
+        "title": "Notification Rule",
+        "description": "Schema for a single notification rule",
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "notificationRuleId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "ownerId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "ownerType": {
+            "type": "string",
+            "enum": [
+              "instance"
+            ]
+          },
+          "creationDate": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "lastUpdated": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "createdById": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "createdByType": {
+            "type": "string",
+            "enum": [
+              "apiToken",
+              "user"
+            ]
+          },
+          "lastUpdatedById": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "lastUpdatedByType": {
+            "type": "string",
+            "enum": [
+              "apiToken",
+              "user"
+            ]
+          },
+          "targetType": {
+            "type": "string",
+            "enum": [
+              "organization"
+            ]
+          },
+          "targetQueryJson": {
+            "type": "string",
+            "maxLength": 8192
+          },
+          "name": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 255
+          },
+          "description": {
+            "type": "string",
+            "maxLength": 32767
+          },
+          "enabled": {
+            "type": "boolean"
+          },
+          "callbackUrl": {
+            "type": "string",
+            "format": "uri",
+            "maxLength": 1024
+          },
+          "emailConfig": {
+            "type": "object",
+            "properties": {
+              "subjectTemplate": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 1024
+              },
+              "bodyTemplate": {
+                "type": "string",
+                "maxLength": 32767
+              },
+              "sendToTarget": {
+                "type": "string",
+                "enum": [
+                  "admins",
+                  "members",
+                  "none"
+                ]
+              },
+              "sendToOwner": {
+                "type": "string",
+                "enum": [
+                  "admins",
+                  "members",
+                  "none"
+                ]
+              },
+              "sendToAddresses": {
+                "type": "array",
+                "maxItems": 10,
+                "items": {
+                  "type": "string",
+                  "format": "email",
+                  "maxLength": 1024
+                }
+              }
+            },
+            "required": [
+              "subjectTemplate",
+              "bodyTemplate"
+            ],
+            "additionalProperties": false
+          },
+          "ruleConfig": {
+            "type": "object",
+            "properties": {
+              "ruleType": {
+                "type": "string",
+                "enum": [
+                  "payloadUsage",
+                  "notebookMinuteUsage"
+                ]
+              },
+              "thresholdType": {
+                "type": "string",
+                "enum": [
+                  "percentOfLimit"
+                ]
+              },
+              "threshold": {
+                "type": "number",
+                "minimum": 0,
+                "maximum": 1000
+              },
+              "maxFrequency": {
+                "type": "string",
+                "enum": [
+                  "billingCycle",
+                  "daily"
+                ]
+              }
+            },
+            "required": [
+              "ruleType",
+              "thresholdType",
+              "threshold"
+            ],
+            "additionalProperties": false
+          }
+        }
+      }
+    },
+    "count": {
+      "type": "integer"
+    },
+    "totalCount": {
+      "type": "integer"
+    },
+    "perPage": {
+      "type": "integer"
+    },
+    "page": {
+      "type": "integer"
+    },
+    "filter": {
+      "type": "string"
+    },
+    "filterField": {
+      "type": "string"
+    },
+    "sortField": {
+      "type": "string"
+    },
+    "sortDirection": {
+      "type": "string",
+      "enum": [
+        "asc",
+        "desc",
+        "ASC",
+        "DESC",
+        ""
+      ]
+    },
+    "ownerId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "ownerType": {
+      "type": "string",
+      "enum": [
+        "instance"
+      ]
+    }
+  }
+}
+```
+### <a name="notification-rules-example"></a> Example
+
+```json
+{
+  "items": [
+    {
+      "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": {
+        "subjectTemplate": "Limit Exceeded",
+        "bodyTemplate": "Org has exceeded its payload limit",
+        "sendToTarget": "admins",
+        "sendToOwner": "none",
+        "sendToAddresses": []
+      },
+      "ruleConfig": {
+        "ruleType": "payloadUsage",
+        "thresholdType": "percentOfLimit",
+        "threshold": 100,
+        "maxFrequency": "billingCycle"
+      }
+    }
+  ],
+  "count": 1,
+  "totalCount": 4,
+  "perPage": 1,
+  "page": 0,
+  "sortField": "name",
+  "sortDirection": "asc",
+  "ownerId": "60106426dc03c6aad06560ba",
+  "ownerType": "instance"
+}
+```
+
+<br/>
+
 ## Organization
 
 Schema for a single Organization
@@ -167380,6 +168749,15 @@ SAML Response body for login
               "instanceCustomNode.delete",
               "instanceCustomNode.errors",
               "instanceCustomNode.stats",
+              "instanceNotificationRules.*",
+              "instanceNotificationRules.get",
+              "instanceNotificationRules.post",
+              "instanceNotificationRule.*",
+              "instanceNotificationRule.get",
+              "instanceNotificationRule.patch",
+              "instanceNotificationRule.delete",
+              "instanceNotificationRule.evaluate",
+              "instanceNotificationRule.logs",
               "instanceSandbox.*",
               "instanceSandbox.get",
               "instanceSandbox.delete",
@@ -170533,6 +171911,15 @@ Schema for the body of a User authentication request
               "instanceCustomNode.delete",
               "instanceCustomNode.errors",
               "instanceCustomNode.stats",
+              "instanceNotificationRules.*",
+              "instanceNotificationRules.get",
+              "instanceNotificationRules.post",
+              "instanceNotificationRule.*",
+              "instanceNotificationRule.get",
+              "instanceNotificationRule.patch",
+              "instanceNotificationRule.delete",
+              "instanceNotificationRule.evaluate",
+              "instanceNotificationRule.logs",
               "instanceSandbox.*",
               "instanceSandbox.get",
               "instanceSandbox.delete",
@@ -171116,6 +172503,15 @@ Schema for the body of a User creation request
               "instanceCustomNode.delete",
               "instanceCustomNode.errors",
               "instanceCustomNode.stats",
+              "instanceNotificationRules.*",
+              "instanceNotificationRules.get",
+              "instanceNotificationRules.post",
+              "instanceNotificationRule.*",
+              "instanceNotificationRule.get",
+              "instanceNotificationRule.patch",
+              "instanceNotificationRule.delete",
+              "instanceNotificationRule.evaluate",
+              "instanceNotificationRule.logs",
               "instanceSandbox.*",
               "instanceSandbox.get",
               "instanceSandbox.delete",