RomM · Schema
NotificationCreatePayload
A notification sent through the API, shown with its own title and body.
CompanyOpen SourceRetro GamingMedia ManagementDocker
Properties
| Name | Type | Description |
|---|---|---|
| title | string | |
| body | object | |
| level | object | |
| kind | string | |
| link | object | A path inside RomM, such as `/rom/12`. |
| icon | object | A Material Design Icons name, such as `mdi-sync`. |
| data | object | |
| recipients | object | User ids, `admins` or `all`; only an admin may notify anyone but themselves. Null notifies the caller. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/romm/json-schema/romm-notification-create-payload-schema.json",
"title": "NotificationCreatePayload",
"description": "A notification sent through the API, shown with its own title and body.",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/romm-notifications-api-openapi.yml#/components/schemas/NotificationCreatePayload",
"properties": {
"title": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"title": "Title"
},
"body": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "null"
}
],
"title": "Body"
},
"level": {
"$ref": "#/$defs/NotificationLevel",
"default": "info"
},
"kind": {
"type": "string",
"maxLength": 64,
"pattern": "^[a-z0-9][a-z0-9_.:-]*$",
"title": "Kind",
"default": "custom"
},
"link": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "null"
}
],
"title": "Link",
"description": "A path inside RomM, such as `/rom/12`."
},
"icon": {
"anyOf": [
{
"type": "string",
"maxLength": 64,
"pattern": "^mdi-[a-z0-9-]+$"
},
{
"type": "null"
}
],
"title": "Icon",
"description": "A Material Design Icons name, such as `mdi-sync`."
},
"data": {
"additionalProperties": true,
"type": "object",
"title": "Data"
},
"recipients": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "string",
"enum": [
"admins",
"all"
]
},
{
"type": "null"
}
],
"title": "Recipients",
"description": "User ids, `admins` or `all`; only an admin may notify anyone but themselves. Null notifies the caller."
}
},
"type": "object",
"required": [
"title"
],
"$defs": {
"NotificationLevel": {
"type": "string",
"enum": [
"info",
"success",
"warning",
"error"
],
"title": "NotificationLevel"
}
}
}
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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/romm-notification-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.