These docs are for v1.5. Click to read the latest docs for v1.6.

iOS: Interruption Levels

A guide to interruption levels in iOS push notifications.

From iOS 15, Apple has introduced the interruption-level field for iOS push notification payloads. It is designed to allow iOS devices to properly display notifications with respect to the user's Focus mode and Notification Summary settings. There are four possible interruption level values:

Interruption LevelPayload ValueDescription
PassivepassiveMinimal interruption, used for information with no urgency attached.
Active (Default)activeSimilar to push functionality in previous iOS versions, used for information that the user may wish to consume as it arrives.
Time Sensitivetime-sensitiveRequires an app entitlement. Appears immediately, breaking through Focus mode and Notification Summary settings (if permitted by user). Used for information that requires immediate attention.
CriticalcriticalRequires an approved entitlement. Appears immediately, overriding ring/silent settings. Used for health and public safety updates.

Apple has a guide to interruption levels, the situations in which they should be used for and how they will be handled on the device here.

Adding Interruption Levels

Notification Builder Interface

Interruption Levels can be added when building a push notification by selecting 'Interruption Level' from the iOS Only options:

470 470

The desired Interruption Level can then be selected from the dropdown:

470

REST API

Interruption Levels can be added to notifications sent through our Notifications, Transactional Notifications and Messages API endpoints by using the key interruption_level with the correct 'Payload Value' listed above. This should be added to the notification.payload field:

{
  "notification": {
    "payload": {
	    "title": "hello",
      "alert": "there",
	    "interruption_level": "time-sensitive"
    }
  }
}