Ably · Schema

Notification

RealtimeWebSocketsPub/SubMessagingStreamingPush NotificationsChatLiveSync

Properties

Name Type Description
title string Title to display at the notification.
body string Text below title on the expanded notification.
icon string Platform-specific icon for the notification.
sound string Platform-specific sound for the notification.
collapseKey string Platform-specific, used to group notifications together.
View JSON Schema on GitHub

JSON Schema

ably-notification-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Notification",
  "title": "Notification",
  "type": "object",
  "properties": {
    "title": {
      "description": "Title to display at the notification.",
      "type": "string"
    },
    "body": {
      "description": "Text below title on the expanded notification.",
      "type": "string"
    },
    "icon": {
      "description": "Platform-specific icon for the notification.",
      "type": "string"
    },
    "sound": {
      "description": "Platform-specific sound for the notification.",
      "type": "string"
    },
    "collapseKey": {
      "description": "Platform-specific, used to group notifications together.",
      "type": "string"
    }
  }
}