RomM · Schema

AppriseChannelCreatePayload

CompanyOpen SourceRetro GamingMedia ManagementDocker

Properties

Name Type Description
min_level object
topics object
type string
name string
service string
fields object
View JSON Schema on GitHub

JSON Schema

romm-apprise-channel-create-payload-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/romm/json-schema/romm-apprise-channel-create-payload-schema.json",
  "title": "AppriseChannelCreatePayload",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/romm-notification-channels-api-openapi.yml#/components/schemas/AppriseChannelCreatePayload",
  "properties": {
    "min_level": {
      "$ref": "#/$defs/NotificationChannelMinLevel",
      "default": "info"
    },
    "topics": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/$defs/NotificationTopic"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Topics"
    },
    "type": {
      "type": "string",
      "const": "apprise",
      "title": "Type"
    },
    "name": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "title": "Name"
    },
    "service": {
      "type": "string",
      "maxLength": 32,
      "minLength": 1,
      "title": "Service"
    },
    "fields": {
      "additionalProperties": {
        "anyOf": [
          {
            "type": "boolean"
          },
          {
            "type": "integer"
          },
          {
            "type": "number"
          },
          {
            "type": "string",
            "maxLength": 2000
          },
          {
            "items": {
              "type": "string",
              "maxLength": 2000
            },
            "type": "array",
            "maxItems": 20
          }
        ]
      },
      "type": "object",
      "maxProperties": 64,
      "title": "Fields"
    }
  },
  "type": "object",
  "required": [
    "type",
    "name",
    "service",
    "fields"
  ],
  "$defs": {
    "NotificationChannelMinLevel": {
      "type": "string",
      "enum": [
        "info",
        "warning",
        "error"
      ],
      "title": "NotificationChannelMinLevel",
      "description": "The least severe notification a channel forwards; success ranks as info."
    },
    "NotificationTopic": {
      "type": "string",
      "enum": [
        "scans",
        "tasks",
        "streaming",
        "devices",
        "account",
        "custom"
      ],
      "title": "NotificationTopic",
      "description": "The groups a notification channel picks what it forwards by."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/romm-apprise-channel-create-payload"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.