Skip to content

Developer Documentation

  • Concepts - How a notification flows through scenarios, deliveries, targets, envelopes and transports
  • Roadmap, feature and architecture RFCs and Design Principles
  • Diagrams - technical diagrams for data flow and architecture
  • JSON Schemas
    • Automatically generated from Home Assistant voluptuous Python schemas, covering both configuration and Action data
    • Also available as plain JSON Schema documents, for example Full_Configuration.schema.json
  • Classes
    • Most important classes used inside Supernotify
  • Transports
    • Table of Transport Adaptor configuration options automatically generated from current Python code

Code coverage, Home Assistant integration audit data and example renders of the provided default HTML eMail template, showing how it looks for different priority levels, are in Reference.

Developer Shell

The ha-repl developer shell has a custom plugins for the common Supernotify classes, like the registries, scenarios, people etc. You will need to call ha-repl trust in the directory to use it first, since the plugin code runs at startup. See Developer Shell for what it offers and how to use it.

scenarios access

More Developer Help

See also transport and options tables in the Reference section.

Find out more at the Supernotify GitHub repo