Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Notification rules

Update notification rule

Updates a notification rule with given id in the request.

patch/api/{cloudId}/v1/notification-rules/{id}

Path parameters

idstring required

Identifier of the notification rule

Request body

namestring required

Name of the notification rule.

actionType'create-alert' | 'acknowledged-alert' | 'closed-alert' | 'assigned-alert' | 'add-note' | 'schedule-start' | 'schedule-end' | 'incoming-call-routing' required

Type of the action that notification rule will have.

notificationTimestring[]

List of Time Periods that notification for schedule start/end will be sent.

schedulesstring[]

This field is valid for Schedule Start/End rules. It can be list of schedule IDs that notification rule will be applied when on call of that schedule starts/ends. This field shall only be populated with the specified users' schedules.

orderinteger

The order of the notification rule within the notification rules with the same action type. Order value is actually the index of the notification rule whose minimum value is 0 and whose maximum value is n-1 (number of notification rules with the same action type is n).

enabledboolean required

If notification rule will be enabled or not when it is created.

Example request

{
  "name": "Create Alert",
  "actionType": "create-alert",
  "criteria": {
    "type": "match-all"
  },
  "steps": [
    {
      "id": "0hcb717e-c442-4185-8bc1-cc998844f567",
      "sendAfter": 0,
      "contact": {
        "method": "email",
        "to": "test@atlassian.com"
      },
      "enabled": true
    }
  ],
  "enabled": true
}

Response

Returned if the request is successful.

idstring

Identifier of the notification rule.

namestring

Name of the notification rule.

actionType'create-alert' | 'acknowledged-alert' | 'closed-alert' | 'assigned-alert' | 'add-note' | 'schedule-start' | 'schedule-end' | 'incoming-call-routing'

Type of the action that notification rule will have.

notificationTimestring[]

List of Time Periods that notification for schedule start/end will be sent. If actionType is scheduleStart or scheduleEnd, notificationTime is mandatory.

schedulesstring[]

This field is valid for Schedule Start/End rules. It can be list of schedule IDs that notification rule will be applied when on call of that schedule starts/ends. This field shall only be populated with the specified users' schedules.

orderinteger

The order of the notification rule within the notification rules with the same action type. Order value is actually the index of the notification rule whose minimum value is 0 and whose maximum value is n-1 (number of notification rules with the same action type is n).

enabledboolean

If notification rule will be enabled or not when it is created.

Example response

{
  "id": "4292c912-12ac-4ac0-b195-9484fbb98c5c",
  "name": "Create Alert",
  "actionType": "create-alert",
  "criteria": {
    "type": "match-all"
  },
  "timeRestriction": {
    "type": "weekday-and-time-of-day",
    "restrictions": [
      {
        "startDay": "monday",
        "endDay": "friday",
        "startHour": 13,
        "endHour": 18,
        "startMin": 0,
        "endMin": 0
      }
    ]
  },
  "order": 1,
  "steps": [
    {
      "id": "0hcb717e-c442-4185-8bc1-cc998844f567",
      "sendAfter": 0,
      "contact": {
        "method": "email",
        "to": "test@atlassian.com"
      },
      "enabled": true
    }
  ],
  "repeat": {
    "loopAfter": 1,
    "enabled": true
  },
  "enabled": true
}