RomM

RomM Notification Channels API

The notification-channels API from RomM — 7 operation(s) for notification-channels.

GitHub OpenAPI

Operations 9

GET /api/notification-channels Get Notification Channels #
POST /api/notification-channels Create Notification Channel #
GET /api/notification-channels/apprise-services Get Apprise Services #
POST /api/notification-channels/apprise-services/parse Parse Apprise Url #
PATCH /api/notification-channels/{channel_id} Update Notification Channel #
DELETE /api/notification-channels/{channel_id} Delete Notification Channel #
POST /api/notification-channels/{channel_id}/test Test Notification Channel #
POST /api/notification-channels/{channel_id}/confirm Confirm Notification Channel #
POST /api/notification-channels/{channel_id}/resend-code Resend Notification Channel Code #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/romm/openapi/romm-notification-channels-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/romm/json-schema/romm-detailed-rom-schema-schema.json
📊
JSONSchema
https://artifacts.apis.io/romm/json-schema/romm-simple-rom-schema-schema.json
📊
JSONSchema
https://artifacts.apis.io/romm/json-schema/romm-config-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/romm/json-schema/romm-body-update-rom-api-roms-id-put-schema.json
📊
JSONSchema
https://artifacts.apis.io/romm/json-schema/romm-platform-schema-schema.json
📊
JSONSchema
https://artifacts.apis.io/romm/json-schema/romm-search-rom-schema-schema.json

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/romm:romm-notification-channels-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

romm-notification-channels-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: RomM Notification Channels API
  version: 5.4.0
tags:
- name: notification-channels
paths:
  /api/notification-channels:
    get:
      tags:
      - notification-channels
      summary: Get Notification Channels
      description: The caller's notification channels.
      operationId: get_notification_channels_api_notification_channels_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/NotificationChannelSchema'
                type: array
                title: Response Get Notification Channels Api Notification Channels Get
      security:
      - OAuth2PasswordBearer:
        - me.read
      - HTTPBasic: []
    post:
      tags:
      - notification-channels
      summary: Create Notification Channel
      description: Add a channel; an email address gets a code to confirm it with first.
      operationId: create_notification_channel_api_notification_channels_post
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/AppriseChannelCreatePayload'
              - $ref: '#/components/schemas/WebhookChannelCreatePayload'
              - $ref: '#/components/schemas/EmailChannelCreatePayload'
              title: Payload
              discriminator:
                propertyName: type
                mapping:
                  apprise: '#/components/schemas/AppriseChannelCreatePayload'
                  webhook: '#/components/schemas/WebhookChannelCreatePayload'
                  email: '#/components/schemas/EmailChannelCreatePayload'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationChannelSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer:
        - me.write
      - HTTPBasic: []
  /api/notification-channels/apprise-services:
    get:
      tags:
      - notification-channels
      summary: Get Apprise Services
      description: Every service an admin's Apprise channel can go out on, with its fields.
      operationId: get_apprise_services_api_notification_channels_apprise_services_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AppriseServiceSchema'
                type: array
                title: Response Get Apprise Services Api Notification Channels Apprise Services Get
      security:
      - OAuth2PasswordBearer:
        - me.read
      - HTTPBasic: []
  /api/notification-channels/apprise-services/parse:
    post:
      tags:
      - notification-channels
      summary: Parse Apprise Url
      description: Read a service's own URL (a Discord webhook's) or an Apprise URL into its fields.
      operationId: parse_apprise_url_api_notification_channels_apprise_services_parse_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppriseUrlPayload'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppriseUrlFieldsSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer:
        - me.read
      - HTTPBasic: []
  /api/notification-channels/{channel_id}:
    patch:
      tags:
      - notification-channels
      summary: Update Notification Channel
      description: Change a channel; a new email address has to be confirmed again.
      operationId: update_notification_channel_api_notification_channels__channel_id__patch
      security:
      - OAuth2PasswordBearer:
        - me.write
      - HTTPBasic: []
      parameters:
      - name: channel_id
        in: path
        required: true
        schema:
          type: integer
          title: Channel Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationChannelUpdatePayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationChannelSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - notification-channels
      summary: Delete Notification Channel
      operationId: delete_notification_channel_api_notification_channels__channel_id__delete
      security:
      - OAuth2PasswordBearer:
        - me.write
      - HTTPBasic: []
      parameters:
      - name: channel_id
        in: path
        required: true
        schema:
          type: integer
          title: Channel Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/notification-channels/{channel_id}/test:
    post:
      tags:
      - notification-channels
      summary: Test Notification Channel
      description: Send a sample notification out on the channel right away.
      operationId: test_notification_channel_api_notification_channels__channel_id__test_post
      security:
      - OAuth2PasswordBearer:
        - me.write
      - HTTPBasic: []
      parameters:
      - name: channel_id
        in: path
        required: true
        schema:
          type: integer
          title: Channel Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationChannelTestResult'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/notification-channels/{channel_id}/confirm:
    post:
      tags:
      - notification-channels
      summary: Confirm Notification Channel
      description: Confirm an email address with the code sent to it.
      operationId: confirm_notification_channel_api_notification_channels__channel_id__confirm_post
      security:
      - OAuth2PasswordBearer:
        - me.write
      - HTTPBasic: []
      parameters:
      - name: channel_id
        in: path
        required: true
        schema:
          type: integer
          title: Channel Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationChannelCodePayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationChannelSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/notification-channels/{channel_id}/resend-code:
    post:
      tags:
      - notification-channels
      summary: Resend Notification Channel Code
      operationId: resend_notification_channel_code_api_notification_channels__channel_id__resend_code_post
      security:
      - OAuth2PasswordBearer:
        - me.write
      - HTTPBasic: []
      parameters:
      - name: channel_id
        in: path
        required: true
        schema:
          type: integer
          title: Channel Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    NotificationChannelType:
      type: string
      enum:
      - apprise
      - webhook
      - email
      title: NotificationChannelType
    NotificationChannelUpdatePayload:
      properties:
        name:
          anyOf:
          - type: string
            maxLength: 100
            minLength: 1
          - type: 'null'
          title: Name
        enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Enabled
        min_level:
          anyOf:
          - $ref: '#/components/schemas/NotificationChannelMinLevel'
          - type: 'null'
        topics:
          anyOf:
          - items:
              $ref: '#/components/schemas/NotificationTopic'
            type: array
          - type: 'null'
          title: Topics
        url:
          anyOf:
          - type: string
            maxLength: 2000
            minLength: 1
          - type: 'null'
          title: Url
        secret:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          title: Secret
        address:
          anyOf:
          - type: string
            maxLength: 320
          - type: 'null'
          title: Address
        fields:
          anyOf:
          - 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
          - type: 'null'
          title: Fields
      type: object
      title: NotificationChannelUpdatePayload
      description: The fields to change; a null `topics` forwards every topic, an empty `secret` drops it.
    AppriseUrlPayload:
      properties:
        url:
          type: string
          maxLength: 2000
          minLength: 1
          title: Url
      type: object
      required:
      - url
      title: AppriseUrlPayload
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    NotificationTopic:
      type: string
      enum:
      - scans
      - tasks
      - streaming
      - devices
      - account
      - custom
      title: NotificationTopic
      description: The groups a notification channel picks what it forwards by.
    AppriseUrlFieldsSchema:
      properties:
        service:
          type: string
          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
          title: Fields
      type: object
      required:
      - service
      - fields
      title: AppriseUrlFieldsSchema
      description: The service a pasted URL is for, and the fields it fills in.
    NotificationChannelTestResult:
      properties:
        ok:
          type: boolean
          title: Ok
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
      type: object
      required:
      - ok
      - error
      title: NotificationChannelTestResult
    AppriseFieldSchema:
      properties:
        key:
          type: string
          title: Key
        label:
          type: string
          title: Label
        type:
          type: string
          enum:
          - string
          - email
          - int
          - float
          - bool
          - choice
          - list
          title: Type
        required:
          type: boolean
          title: Required
        private:
          type: boolean
          title: Private
        advanced:
          type: boolean
          title: Advanced
        default:
          anyOf:
          - type: boolean
          - type: integer
          - type: number
          - type: string
            maxLength: 2000
          - items:
              type: string
              maxLength: 2000
            type: array
            maxItems: 20
          - type: 'null'
          title: Default
        values:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Values
        min:
          anyOf:
          - type: number
          - type: 'null'
          title: Min
        max:
          anyOf:
          - type: number
          - type: 'null'
          title: Max
      type: object
      required:
      - key
      - label
      - type
      - required
      - private
      - advanced
      - default
      - values
      - min
      - max
      title: AppriseFieldSchema
    AppriseChannelCreatePayload:
      properties:
        min_level:
          $ref: '#/components/schemas/NotificationChannelMinLevel'
          default: info
        topics:
          anyOf:
          - items:
              $ref: '#/components/schemas/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
      title: AppriseChannelCreatePayload
    NotificationChannelSchema:
      properties:
        id:
          type: integer
          title: Id
        type:
          $ref: '#/components/schemas/NotificationChannelType'
        name:
          type: string
          title: Name
        enabled:
          type: boolean
          title: Enabled
        min_level:
          $ref: '#/components/schemas/NotificationChannelMinLevel'
        topics:
          anyOf:
          - items:
              $ref: '#/components/schemas/NotificationTopic'
            type: array
          - type: 'null'
          title: Topics
        target:
          type: string
          title: Target
        service:
          anyOf:
          - type: string
          - type: 'null'
          title: Service
        service_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Service Name
        fields:
          anyOf:
          - additionalProperties:
              anyOf:
              - type: boolean
              - type: integer
              - type: number
              - type: string
                maxLength: 2000
              - items:
                  type: string
                  maxLength: 2000
                type: array
                maxItems: 20
            type: object
          - type: 'null'
          title: Fields
        stored_secrets:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Stored Secrets
        has_secret:
          type: boolean
          title: Has Secret
        confirmed:
          type: boolean
          title: Confirmed
        last_delivered_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Delivered At
        last_error:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Error
        consecutive_failures:
          type: integer
          title: Consecutive Failures
        created_at:
          type: string
          title: Created At
      type: object
      required:
      - id
      - type
      - name
      - enabled
      - min_level
      - topics
      - target
      - service
      - service_name
      - fields
      - stored_secrets
      - has_secret
      - confirmed
      - last_delivered_at
      - last_error
      - consecutive_failures
      - created_at
      title: NotificationChannelSchema
    AppriseServiceSchema:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        setup_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Setup Url
        url_fields:
          items:
            type: string
          type: array
          title: Url Fields
        fields:
          items:
            $ref: '#/components/schemas/AppriseFieldSchema'
          type: array
          title: Fields
      type: object
      required:
      - id
      - name
      - setup_url
      - url_fields
      - fields
      title: AppriseServiceSchema
    EmailChannelCreatePayload:
      properties:
        min_level:
          $ref: '#/components/schemas/NotificationChannelMinLevel'
          default: info
        topics:
          anyOf:
          - items:
              $ref: '#/components/schemas/NotificationTopic'
            type: array
          - type: 'null'
          title: Topics
        type:
          type: string
          const: email
          title: Type
        name:
          type: string
          maxLength: 100
          minLength: 1
          title: Name
        address:
          type: string
          maxLength: 320
          title: Address
      type: object
      required:
      - type
      - name
      - address
      title: EmailChannelCreatePayload
    WebhookChannelCreatePayload:
      properties:
        min_level:
          $ref: '#/components/schemas/NotificationChannelMinLevel'
          default: info
        topics:
          anyOf:
          - items:
              $ref: '#/components/schemas/NotificationTopic'
            type: array
          - type: 'null'
          title: Topics
        type:
          type: string
          const: webhook
          title: Type
        name:
          type: string
          maxLength: 100
          minLength: 1
          title: Name
        url:
          type: string
          maxLength: 2000
          minLength: 1
          title: Url
        secret:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          title: Secret
      type: object
      required:
      - type
      - name
      - url
      title: WebhookChannelCreatePayload
    NotificationChannelCodePayload:
      properties:
        code:
          type: string
          maxLength: 16
          minLength: 1
          title: Code
      type: object
      required:
      - code
      title: NotificationChannelCodePayload
    NotificationChannelMinLevel:
      type: string
      enum:
      - info
      - warning
      - error
      title: NotificationChannelMinLevel
      description: The least severe notification a channel forwards; success ranks as info.
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes:
            me.read: View your profile
            roms.read: View ROMs
            platforms.read: View platforms
            assets.read: View assets
            devices.read: View devices
            firmware.read: View firmware
            roms.user.read: View user-rom properties
            collections.read: View collections
            playlists.read: View music playlists
            me.write: Modify your profile
            assets.write: Modify assets
            devices.write: Modify devices
            roms.user.write: Modify user-rom properties
            collections.write: Modify collections
            playlists.write: Modify music playlists
            roms.write: Modify ROMs
            platforms.write: Modify platforms
            firmware.write: Modify firmware
            users.read: View users
            users.write: Modify users
            tasks.run: Run tasks
            logs.read: View backend logs
          tokenUrl: /token
    HTTPBasic:
      type: http
      scheme: basic