Backblaze · JSON Structure

B2 Native Api Notification Rule Structure

NotificationRule schema from Backblaze B2 Native API

Type: object Properties: 4
Cloud StorageObject StorageStorageBackup

NotificationRule is a JSON Structure definition published by Backblaze, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name eventTypes isEnabled targetConfiguration

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/backblaze/refs/heads/main/json-structure/b2-native-api-notification-rule-structure.json",
  "name": "NotificationRule",
  "description": "NotificationRule schema from Backblaze B2 Native API",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name for this notification rule",
      "example": "my-notification"
    },
    "eventTypes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Event types that trigger this notification",
      "example": [
        "b2:ObjectCreated:Upload"
      ]
    },
    "isEnabled": {
      "type": "boolean",
      "description": "Whether this rule is enabled",
      "example": true
    },
    "targetConfiguration": {
      "type": "object",
      "properties": {
        "targetType": {
          "type": "string",
          "enum": [
            "url"
          ],
          "description": "Type of notification target"
        },
        "url": {
          "type": "string",
          "description": "Webhook URL to send notifications to",
          "example": "https://my-app.example.com/webhooks/b2"
        }
      }
    }
  }
}