create #

Creates a new notification rule inside a tenant index.

Return an error if the rule already exists.

Query Syntax #

HTTP #

URL: http://kuzzle:7512/_/notifications/:index
Method: POST
Body:

{
  "rule": {
    "name": "string",
    "description": "string",
    "filters": {},
    "linkedAlertRules": ["string"],
    "plannings": [
      {
        "channels": ["string"],
        "recipients": ["string"],
        "days": {
          "mon": "boolean",
          "tue": "boolean",
          "wed": "boolean",
          "thu": "boolean",
          "fri": "boolean",
          "sat": "boolean",
          "sun": "boolean"
        },
        "range": {
          "allDay": "boolean",
          "start": "string", // HH:mm
          "end": "string" // HH:mm
        },
        "timezone": "string" // Europe/Paris
      }
    ],
    "emailAction": {
      "message": "string",
      "subject": "string",
      "client": "string",
      "enabled": "boolean",
      "tenant": "string"
    },
    "smsAction": {
      "message": "string",
      "subject": "string",
      "client": "string",
      "enabled": "boolean",
      "tenant": "string"
    }
  }
}

Javascript #

kuzzle.query({
  controller: 'notifications',
  action: 'create',
  index: '<index>',
  body: {
    rule: {
      name: 'string',
      description: 'string',
      filters: {},
      linkedAlertRules: ['string'],
      plannings: [
        {
          channels: ['string'],
          recipients: ['string'],
          days: {
            mon: 'boolean',
            tue: 'boolean',
            wed: 'boolean',
            thu: 'boolean',
            fri: 'boolean',
            sat: 'boolean',
            sun: 'boolean',
          },
          range: {
            allDay: 'boolean',
            start: 'string', // HH:mm
            end: 'string', // HH:mm
          },
          timezone: 'string', // Europe/Paris
        },
      ],
      emailAction: {
        message: 'string',
        subject: 'string',
        client: 'string',
        enabled: 'boolean',
        tenant: 'string',
      },
      smsAction: {
        message: 'string',
        subject: 'string',
        client: 'string',
        enabled: 'boolean',
        tenant: 'string',
      },
    },
  },
});

Arguments #

Arguments	Type	Description
`index`	string	Tenant index

Rule Properties #

Arguments	Type	Description
`name`	string	Notification rule name
`description`	string	Notification rule description
`filters`	object	Notification rule filters
`linkedAlertRules`	string[]	Notification rule linked alert rules
`plannings`	object[]	Notification rule plannings
`emailAction`	object	Notification rule email action
`smsAction`	object	Notification rule sms action

Planning Properties #

Arguments	Type	Description
`channels`	string[]	Notification rule channels
`recipients`	string[]	Notification rule recipients
`days`	object	Notification rule days
`range`	object	Notification rule range
`timezone`	string	Notification rule timezone

Email Action Properties #

Arguments	Type	Description
`message`	string	Notification rule email message
`subject`	string	Notification rule email subject
`client`	string	Notification rule email client
`enabled`	boolean	Notification rule email enabled
`tenant`	string	Notification rule email tenant

SMS Action Properties #

Arguments	Type	Description
`message`	string	Notification rule sms message
`subject`	string	Notification rule sms subject
`client`	string	Notification rule sms client
`enabled`	boolean	Notification rule sms enabled
`tenant`	string	Notification rule sms tenant

Edit this page on Github