get #

Gets a notification rule.

Query Syntax #

HTTP #

URL: http://kuzzle:7512/_/notification-rules/:index/:_id
Method: GET

Javascript #

kuzzle.query({
  controller: 'notifications',
  action: 'get',
  index: '<index>',
  _id: '<notification rule id>',
});

Arguments #

index: Tenant index
_id: Notification rule ID

Response #

Returns the notification rule.

{
  "status": 200,
  "error": null,
  "controller": "notifications",
  "action": "get",
  "index": "<tenant-air_quality-kuzzle>",
  "requestId": "<unique request identifier>",
  "result": {
    "name": "<rule name>",
    "description": "<rule description>",
    "disabled": false, // boolean
    "filters": {
      // filters
    },
    "sendgridAction": {
      "client": "sendgrid",
      "type": "email",
      "tenant": "<tenant-air_quality-kuzzle>",
      "enabled": false, // boolean
      "recipients": "<mail@kuzzle.io>",
      "subject": "<subject>",
      "message": "<message>"
    },
    "smtpAction": {
      "client": "sendgrid",
      "type": "email",
      "tenant": "<tenant-air_quality-kuzzle>",
      "enabled": false, // boolean
      "recipients": "<mail@kuzzle.io>",
      "subject": "<subject>",
      "message": "<message>"
    },
    "twilioAction": {
      "client": "sendgrid",
      "type": "email",
      "tenant": "<tenant-air_quality-kuzzle>",
      "enabled": false, // boolean
      "recipients": "<mail@kuzzle.io>",
      "subject": "<subject>",
      "message": "<message>"
    }
  }
 }

Edit this page on Github