Skip to content

Full Configuration

Title: Full Configuration
Type object
Required No
Additional properties Any type allowed

Description: Voluptuous validation schema for Full_Configuration

Property Pattern Type Deprecated
- delivery No object No
- action_groups No object No
- recipients No array of object No
- links No array of object No
- scenarios No object No
- transports No object No
- cameras No array of object No
- snooze No object No
- template_path No string No
- media_path No string No
- media_url_prefix No string No
- archive No object No
- housekeeping No object No
- dupe_check No object No
- mobile_discovery No boolean No
- recipients_discovery No boolean No
- No object No

Property Full Configuration > delivery
Type object
Required No
Additional properties Each additional property must conform to the schema
Default {}
Property Pattern Type Deprecated
- No object No

Property Full Configuration > delivery > additionalProperties
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- action No string No
- debug No string No
- options No object No
- data No object No
- target No Combination No
- target_required No Combination No
- target_usage No enum (of string) No
- selection No array of enum (of string) No
- priority No array No
- selection_rank No enum (of string) No
+ transport No enum (of string) No
- alias No string No
- template No string No
- message No string No
- title No string No
- enabled No string No
- occupancy No enum (of string) No
- conditions No array of string No

Property Full Configuration > delivery > additionalProperties > action
Type string
Required No

Property Full Configuration > delivery > additionalProperties > debug
Type string
Required No

Property Full Configuration > delivery > additionalProperties > options
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No

Property Full Configuration > delivery > additionalProperties > data
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No

Property Full Configuration > delivery > additionalProperties > target
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
item 2
Property Full Configuration > delivery > additionalProperties > target > anyOf > item 0
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- entity_id No array of string No
- device_id No array of string No
- area_id No array of string No
- floor_id No array of string No
- label_id No array of string No
- email No array of string No
- phone No array of string No
- mobile_app_id No array of string No
- person_id No array of string No
- No array of string No
Property Full Configuration > delivery > additionalProperties > target > anyOf > item 0 > entity_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
entity_id items -
Full Configuration > delivery > additionalProperties > target > anyOf > item 0 > entity_id > entity_id items
Type string
Required No
Property Full Configuration > delivery > additionalProperties > target > anyOf > item 0 > device_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
device_id items -
Full Configuration > delivery > additionalProperties > target > anyOf > item 0 > device_id > device_id items
Type string
Required No
Property Full Configuration > delivery > additionalProperties > target > anyOf > item 0 > area_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
area_id items -
Full Configuration > delivery > additionalProperties > target > anyOf > item 0 > area_id > area_id items
Type string
Required No
Property Full Configuration > delivery > additionalProperties > target > anyOf > item 0 > floor_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
floor_id items -
Full Configuration > delivery > additionalProperties > target > anyOf > item 0 > floor_id > floor_id items
Type string
Required No
Property Full Configuration > delivery > additionalProperties > target > anyOf > item 0 > label_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
label_id items -
Full Configuration > delivery > additionalProperties > target > anyOf > item 0 > label_id > label_id items
Type string
Required No
Property Full Configuration > delivery > additionalProperties > target > anyOf > item 0 > email
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
email items -
Full Configuration > delivery > additionalProperties > target > anyOf > item 0 > email > email items
Type string
Required No
Property Full Configuration > delivery > additionalProperties > target > anyOf > item 0 > phone
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
phone items -
Full Configuration > delivery > additionalProperties > target > anyOf > item 0 > phone > phone items
Type string
Required No
Property Full Configuration > delivery > additionalProperties > target > anyOf > item 0 > mobile_app_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
mobile_app_id items -
Full Configuration > delivery > additionalProperties > target > anyOf > item 0 > mobile_app_id > mobile_app_id items
Type string
Required No
Property Full Configuration > delivery > additionalProperties > target > anyOf > item 0 > person_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
person_id items -
Full Configuration > delivery > additionalProperties > target > anyOf > item 0 > person_id > person_id items
Type string
Required No
Property Full Configuration > delivery > additionalProperties > target > anyOf > item 0 > additionalProperties
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
additionalProperties items -
Full Configuration > delivery > additionalProperties > target > anyOf > item 0 > additionalProperties > additionalProperties items
Type string
Required No
Property Full Configuration > delivery > additionalProperties > target > anyOf > item 1
Type string
Required No
Property Full Configuration > delivery > additionalProperties > target > anyOf > item 2
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
item 2 items -
Full Configuration > delivery > additionalProperties > target > anyOf > item 2 > item 2 items
Type string
Required No

Property Full Configuration > delivery > additionalProperties > target_required
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
Property Full Configuration > delivery > additionalProperties > target_required > anyOf > item 0
Type object
Required No
Additional properties Any type allowed
Property Full Configuration > delivery > additionalProperties > target_required > anyOf > item 1
Type enum (of string)
Required No

Must be one of: * "always" * "never" * "optional"

Property Full Configuration > delivery > additionalProperties > target_usage
Type enum (of string)
Required No

Must be one of: * "no_delivery" * "no_action" * "merge_delivery" * "merge_always" * "fixed"

Property Full Configuration > delivery > additionalProperties > selection
Type array of enum (of string)
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
selection items -
Full Configuration > delivery > additionalProperties > selection > selection items
Type enum (of string)
Required No

Must be one of: * "fallback_on_error" * "explicit" * "scenario" * "default" * "fallback"

Property Full Configuration > delivery > additionalProperties > priority
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
priority items -
Full Configuration > delivery > additionalProperties > priority > priority items
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
item 2
Property Full Configuration > delivery > additionalProperties > priority > priority items > anyOf > item 0
Type integer
Required No
Property Full Configuration > delivery > additionalProperties > priority > priority items > anyOf > item 1
Type string
Required No
Property Full Configuration > delivery > additionalProperties > priority > priority items > anyOf > item 2
Type enum (of string)
Required No

Must be one of: * "minimum" * "low" * "medium" * "high" * "critical"

Property Full Configuration > delivery > additionalProperties > selection_rank
Type enum (of string)
Required No

Must be one of: * "ANY" * "FIRST" * "LAST"

Property Full Configuration > delivery > additionalProperties > transport
Type enum (of string)
Required Yes

Must be one of: * "sms" * "mqtt" * "alexa_devices" * "alexa_media_player" * "mobile_push" * "chime" * "email" * "media" * "persistent" * "tts" * "generic" * "notify_entity" * "ntfy" * "gotify" * "telegram" * "lametric" * "pushover" * "html5" * "matrix" * "kodi" * "discord"

Property Full Configuration > delivery > additionalProperties > alias
Type string
Required No

Property Full Configuration > delivery > additionalProperties > template
Type string
Required No

Property Full Configuration > delivery > additionalProperties > message
Type string
Required No

Property Full Configuration > delivery > additionalProperties > title
Type string
Required No

Property Full Configuration > delivery > additionalProperties > enabled
Type string
Required No

Property Full Configuration > delivery > additionalProperties > occupancy
Type enum (of string)
Required No
Default "all"

Must be one of: * "all_in" * "all_out" * "any_in" * "any_out" * "only_in" * "only_out" * "all" * "none"

Property Full Configuration > delivery > additionalProperties > conditions
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
conditions items -
Full Configuration > delivery > additionalProperties > conditions > conditions items
Type string
Required No

Property Full Configuration > action_groups
Type object
Required No
Additional properties Each additional property must conform to the schema
Default {}
Property Pattern Type Deprecated
- No array of object No

Property Full Configuration > action_groups > additionalProperties
Type array of object
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
additionalProperties items -

Full Configuration > action_groups > additionalProperties > additionalProperties items
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- action No string No
- title No string No
- uri No string No
- icon No string No
- No object No
Property Full Configuration > action_groups > additionalProperties > additionalProperties items > action
Type string
Required No
Property Full Configuration > action_groups > additionalProperties > additionalProperties items > title
Type string
Required No
Property Full Configuration > action_groups > additionalProperties > additionalProperties items > uri
Type string
Required No
Property Full Configuration > action_groups > additionalProperties > additionalProperties items > icon
Type string
Required No

Property Full Configuration > recipients
Type array of object
Required No
Default []
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
recipients items -

Full Configuration > recipients > recipients items
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
+ person No string No
- alias No string No
- email No string No
- enabled No boolean No
- target No Combination No
- phone_number No string No
- mobile_discovery No boolean No
- mobile_devices No array of object No
- delivery No object No

Property Full Configuration > recipients > recipients items > person
Type string
Required Yes

Property Full Configuration > recipients > recipients items > alias
Type string
Required No

Property Full Configuration > recipients > recipients items > email
Type string
Required No

Property Full Configuration > recipients > recipients items > enabled
Type boolean
Required No
Default true

Property Full Configuration > recipients > recipients items > target
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
item 2
Property Full Configuration > recipients > recipients items > target > anyOf > item 0
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- entity_id No array of string No
- device_id No array of string No
- area_id No array of string No
- floor_id No array of string No
- label_id No array of string No
- email No array of string No
- phone No array of string No
- mobile_app_id No array of string No
- person_id No array of string No
- No array of string No
Property Full Configuration > recipients > recipients items > target > anyOf > item 0 > entity_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
entity_id items -
Full Configuration > recipients > recipients items > target > anyOf > item 0 > entity_id > entity_id items
Type string
Required No
Property Full Configuration > recipients > recipients items > target > anyOf > item 0 > device_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
device_id items -
Full Configuration > recipients > recipients items > target > anyOf > item 0 > device_id > device_id items
Type string
Required No
Property Full Configuration > recipients > recipients items > target > anyOf > item 0 > area_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
area_id items -
Full Configuration > recipients > recipients items > target > anyOf > item 0 > area_id > area_id items
Type string
Required No
Property Full Configuration > recipients > recipients items > target > anyOf > item 0 > floor_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
floor_id items -
Full Configuration > recipients > recipients items > target > anyOf > item 0 > floor_id > floor_id items
Type string
Required No
Property Full Configuration > recipients > recipients items > target > anyOf > item 0 > label_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
label_id items -
Full Configuration > recipients > recipients items > target > anyOf > item 0 > label_id > label_id items
Type string
Required No
Property Full Configuration > recipients > recipients items > target > anyOf > item 0 > email
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
email items -
Full Configuration > recipients > recipients items > target > anyOf > item 0 > email > email items
Type string
Required No
Property Full Configuration > recipients > recipients items > target > anyOf > item 0 > phone
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
phone items -
Full Configuration > recipients > recipients items > target > anyOf > item 0 > phone > phone items
Type string
Required No
Property Full Configuration > recipients > recipients items > target > anyOf > item 0 > mobile_app_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
mobile_app_id items -
Full Configuration > recipients > recipients items > target > anyOf > item 0 > mobile_app_id > mobile_app_id items
Type string
Required No
Property Full Configuration > recipients > recipients items > target > anyOf > item 0 > person_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
person_id items -
Full Configuration > recipients > recipients items > target > anyOf > item 0 > person_id > person_id items
Type string
Required No
Property Full Configuration > recipients > recipients items > target > anyOf > item 0 > additionalProperties
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
additionalProperties items -
Full Configuration > recipients > recipients items > target > anyOf > item 0 > additionalProperties > additionalProperties items
Type string
Required No
Property Full Configuration > recipients > recipients items > target > anyOf > item 1
Type string
Required No
Property Full Configuration > recipients > recipients items > target > anyOf > item 2
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
item 2 items -
Full Configuration > recipients > recipients items > target > anyOf > item 2 > item 2 items
Type string
Required No

Property Full Configuration > recipients > recipients items > phone_number
Type string
Required No

Property Full Configuration > recipients > recipients items > mobile_discovery
Type boolean
Required No
Default true

Property Full Configuration > recipients > recipients items > mobile_devices
Type array of object
Required No
Default []
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
mobile_devices items -
Full Configuration > recipients > recipients items > mobile_devices > mobile_devices items
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- manufacturer No string No
- model No string No
- class No string No
- mobile_app_id No string No
- device_tracker No string No
- enabled No string No
Property Full Configuration > recipients > recipients items > mobile_devices > mobile_devices items > manufacturer
Type string
Required No
Property Full Configuration > recipients > recipients items > mobile_devices > mobile_devices items > model
Type string
Required No
Property Full Configuration > recipients > recipients items > mobile_devices > mobile_devices items > class
Type string
Required No
Property Full Configuration > recipients > recipients items > mobile_devices > mobile_devices items > mobile_app_id
Type string
Required No
Property Full Configuration > recipients > recipients items > mobile_devices > mobile_devices items > device_tracker
Type string
Required No
Property Full Configuration > recipients > recipients items > mobile_devices > mobile_devices items > enabled
Type string
Required No
Default true

Property Full Configuration > recipients > recipients items > delivery
Type object
Required No
Additional properties Each additional property must conform to the schema
Default {}
Property Pattern Type Deprecated
- No object No
Property Full Configuration > recipients > recipients items > delivery > additionalProperties
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- target No Combination No
- enabled No string No
- data No object No
Property Full Configuration > recipients > recipients items > delivery > additionalProperties > target
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
item 2
Property Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- entity_id No array of string No
- device_id No array of string No
- area_id No array of string No
- floor_id No array of string No
- label_id No array of string No
- email No array of string No
- phone No array of string No
- mobile_app_id No array of string No
- person_id No array of string No
- No array of string No
Property Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > entity_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
entity_id items -
Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > entity_id > entity_id items
Type string
Required No
Property Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > device_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
device_id items -
Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > device_id > device_id items
Type string
Required No
Property Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > area_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
area_id items -
Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > area_id > area_id items
Type string
Required No
Property Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > floor_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
floor_id items -
Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > floor_id > floor_id items
Type string
Required No
Property Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > label_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
label_id items -
Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > label_id > label_id items
Type string
Required No
Property Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > email
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
email items -
Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > email > email items
Type string
Required No
Property Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > phone
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
phone items -
Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > phone > phone items
Type string
Required No
Property Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > mobile_app_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
mobile_app_id items -
Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > mobile_app_id > mobile_app_id items
Type string
Required No
Property Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > person_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
person_id items -
Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > person_id > person_id items
Type string
Required No
Property Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > additionalProperties
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
additionalProperties items -
Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > additionalProperties > additionalProperties items
Type string
Required No
Property Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 1
Type string
Required No
Property Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 2
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
item 2 items -
Full Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 2 > item 2 items
Type string
Required No
Property Full Configuration > recipients > recipients items > delivery > additionalProperties > enabled
Type string
Required No
Property Full Configuration > recipients > recipients items > delivery > additionalProperties > data
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No
Type array of object
Required No
Default []
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
links items -
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
+ url No string No
+ description No string No
- id No string No
- icon No string No
- name No string No
Type string
Required Yes
Type string
Required Yes
Type string
Required No
Type string
Required No
Type string
Required No

Property Full Configuration > scenarios
Type object
Required No
Additional properties Each additional property must conform to the schema
Default {}
Property Pattern Type Deprecated
- No object No

Property Full Configuration > scenarios > additionalProperties
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- alias No string No
- enabled No string No
- conditions No array of string No
- media No object No
- action_groups No array of string No
- delivery_selection No string No
- delivery No object No

Property Full Configuration > scenarios > additionalProperties > alias
Type string
Required No

Property Full Configuration > scenarios > additionalProperties > enabled
Type string
Required No
Default true

Property Full Configuration > scenarios > additionalProperties > conditions
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
conditions items -
Full Configuration > scenarios > additionalProperties > conditions > conditions items
Type string
Required No

Property Full Configuration > scenarios > additionalProperties > media
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- camera_entity_id No string No
- camera_delay No integer No
- camera_ptz_preset No Combination No
- clip_url No string No
- snapshot_url No string No
- jpeg_opts No object No
- png_opts No object No
Property Full Configuration > scenarios > additionalProperties > media > camera_entity_id
Type string
Required No
Property Full Configuration > scenarios > additionalProperties > media > camera_delay
Type integer
Required No
Default 0
Property Full Configuration > scenarios > additionalProperties > media > camera_ptz_preset
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
Property Full Configuration > scenarios > additionalProperties > media > camera_ptz_preset > anyOf > item 0
Type integer
Required No
Restrictions
Minimum ≥ 0
Property Full Configuration > scenarios > additionalProperties > media > camera_ptz_preset > anyOf > item 1
Type object
Required No
Additional properties Any type allowed
Property Full Configuration > scenarios > additionalProperties > media > clip_url
Type string
Required No
Property Full Configuration > scenarios > additionalProperties > media > snapshot_url
Type string
Required No
Property Full Configuration > scenarios > additionalProperties > media > jpeg_opts
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No
Property Full Configuration > scenarios > additionalProperties > media > png_opts
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No

Property Full Configuration > scenarios > additionalProperties > action_groups
Type array of string
Required No
Default []
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
action_groups items -
Full Configuration > scenarios > additionalProperties > action_groups > action_groups items
Type string
Required No

Property Full Configuration > scenarios > additionalProperties > delivery_selection
Type string
Required No

Property Full Configuration > scenarios > additionalProperties > delivery
Type object
Required No
Additional properties Each additional property must conform to the schema
Default {}
Property Pattern Type Deprecated
- No object No
Property Full Configuration > scenarios > additionalProperties > delivery > additionalProperties
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- target No Combination No
- enabled No string No
- data No object No
Property Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
item 2
Property Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- entity_id No array of string No
- device_id No array of string No
- area_id No array of string No
- floor_id No array of string No
- label_id No array of string No
- email No array of string No
- phone No array of string No
- mobile_app_id No array of string No
- person_id No array of string No
- No array of string No
Property Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > entity_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
entity_id items -
Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > entity_id > entity_id items
Type string
Required No
Property Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > device_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
device_id items -
Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > device_id > device_id items
Type string
Required No
Property Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > area_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
area_id items -
Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > area_id > area_id items
Type string
Required No
Property Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > floor_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
floor_id items -
Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > floor_id > floor_id items
Type string
Required No
Property Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > label_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
label_id items -
Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > label_id > label_id items
Type string
Required No
Property Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > email
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
email items -
Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > email > email items
Type string
Required No
Property Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > phone
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
phone items -
Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > phone > phone items
Type string
Required No
Property Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > mobile_app_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
mobile_app_id items -
Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > mobile_app_id > mobile_app_id items
Type string
Required No
Property Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > person_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
person_id items -
Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > person_id > person_id items
Type string
Required No
Property Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > additionalProperties
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
additionalProperties items -
Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > additionalProperties > additionalProperties items
Type string
Required No
Property Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 1
Type string
Required No
Property Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 2
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
item 2 items -
Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 2 > item 2 items
Type string
Required No
Property Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > enabled
Type string
Required No
Property Full Configuration > scenarios > additionalProperties > delivery > additionalProperties > data
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No

Property Full Configuration > transports
Type object
Required No
Additional properties Each additional property must conform to the schema
Default {}
Property Pattern Type Deprecated
- No object No

Property Full Configuration > transports > additionalProperties
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- alias No string No
- device_domain No array of string No
- device_model_include No array of string No
- device_model_exclude No array of string No
- device_discovery No string No
- enabled No string No
- delivery_defaults No object No
- connection No object No

Property Full Configuration > transports > additionalProperties > alias
Type string
Required No

Property Full Configuration > transports > additionalProperties > device_domain
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
device_domain items -
Full Configuration > transports > additionalProperties > device_domain > device_domain items
Type string
Required No

Property Full Configuration > transports > additionalProperties > device_model_include
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
device_model_include items -
Full Configuration > transports > additionalProperties > device_model_include > device_model_include items
Type string
Required No

Property Full Configuration > transports > additionalProperties > device_model_exclude
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
device_model_exclude items -
Full Configuration > transports > additionalProperties > device_model_exclude > device_model_exclude items
Type string
Required No

Property Full Configuration > transports > additionalProperties > device_discovery
Type string
Required No

Property Full Configuration > transports > additionalProperties > enabled
Type string
Required No
Default true

Property Full Configuration > transports > additionalProperties > delivery_defaults
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- action No string No
- debug No string No
- options No object No
- data No object No
- target No Combination No
- target_required No Combination No
- target_usage No enum (of string) No
- selection No array of enum (of string) No
- priority No array No
- selection_rank No enum (of string) No
Property Full Configuration > transports > additionalProperties > delivery_defaults > action
Type string
Required No
Property Full Configuration > transports > additionalProperties > delivery_defaults > debug
Type string
Required No
Property Full Configuration > transports > additionalProperties > delivery_defaults > options
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No
Property Full Configuration > transports > additionalProperties > delivery_defaults > data
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No
Property Full Configuration > transports > additionalProperties > delivery_defaults > target
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
item 2
Property Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- entity_id No array of string No
- device_id No array of string No
- area_id No array of string No
- floor_id No array of string No
- label_id No array of string No
- email No array of string No
- phone No array of string No
- mobile_app_id No array of string No
- person_id No array of string No
- No array of string No
Property Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > entity_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
entity_id items -
Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > entity_id > entity_id items
Type string
Required No
Property Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > device_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
device_id items -
Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > device_id > device_id items
Type string
Required No
Property Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > area_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
area_id items -
Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > area_id > area_id items
Type string
Required No
Property Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > floor_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
floor_id items -
Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > floor_id > floor_id items
Type string
Required No
Property Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > label_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
label_id items -
Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > label_id > label_id items
Type string
Required No
Property Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > email
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
email items -
Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > email > email items
Type string
Required No
Property Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > phone
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
phone items -
Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > phone > phone items
Type string
Required No
Property Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > mobile_app_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
mobile_app_id items -
Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > mobile_app_id > mobile_app_id items
Type string
Required No
Property Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > person_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
person_id items -
Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > person_id > person_id items
Type string
Required No
Property Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > additionalProperties
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
additionalProperties items -
Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > additionalProperties > additionalProperties items
Type string
Required No
Property Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 1
Type string
Required No
Property Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 2
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
item 2 items -
Full Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 2 > item 2 items
Type string
Required No
Property Full Configuration > transports > additionalProperties > delivery_defaults > target_required
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
Property Full Configuration > transports > additionalProperties > delivery_defaults > target_required > anyOf > item 0
Type object
Required No
Additional properties Any type allowed
Property Full Configuration > transports > additionalProperties > delivery_defaults > target_required > anyOf > item 1
Type enum (of string)
Required No

Must be one of: * "always" * "never" * "optional"

Property Full Configuration > transports > additionalProperties > delivery_defaults > target_usage
Type enum (of string)
Required No

Must be one of: * "no_delivery" * "no_action" * "merge_delivery" * "merge_always" * "fixed"

Property Full Configuration > transports > additionalProperties > delivery_defaults > selection
Type array of enum (of string)
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
selection items -
Full Configuration > transports > additionalProperties > delivery_defaults > selection > selection items
Type enum (of string)
Required No

Must be one of: * "fallback_on_error" * "explicit" * "scenario" * "default" * "fallback"

Property Full Configuration > transports > additionalProperties > delivery_defaults > priority
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
priority items -
Full Configuration > transports > additionalProperties > delivery_defaults > priority > priority items
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
item 2
Property Full Configuration > transports > additionalProperties > delivery_defaults > priority > priority items > anyOf > item 0
Type integer
Required No
Property Full Configuration > transports > additionalProperties > delivery_defaults > priority > priority items > anyOf > item 1
Type string
Required No
Property Full Configuration > transports > additionalProperties > delivery_defaults > priority > priority items > anyOf > item 2
Type enum (of string)
Required No

Must be one of: * "minimum" * "low" * "medium" * "high" * "critical"

Property Full Configuration > transports > additionalProperties > delivery_defaults > selection_rank
Type enum (of string)
Required No

Must be one of: * "ANY" * "FIRST" * "LAST"

Property Full Configuration > transports > additionalProperties > connection
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
+ host No string No
- port No integer No
- encryption No enum (of string) No
- username No string No
- password No string No
- timeout No integer No
- verify_ssl No string No
Property Full Configuration > transports > additionalProperties > connection > host
Type string
Required Yes
Property Full Configuration > transports > additionalProperties > connection > port
Type integer
Required No
Default 587
Restrictions
Minimum ≥ 1
Maximum ≤ 65535
Property Full Configuration > transports > additionalProperties > connection > encryption
Type enum (of string)
Required No
Default "starttls"

Must be one of: * "tls" * "starttls" * "none"

Property Full Configuration > transports > additionalProperties > connection > username
Type string
Required No
Property Full Configuration > transports > additionalProperties > connection > password
Type string
Required No
Property Full Configuration > transports > additionalProperties > connection > timeout
Type integer
Required No
Default 5
Restrictions
Minimum ≥ 0
Property Full Configuration > transports > additionalProperties > connection > verify_ssl
Type string
Required No
Default true

Property Full Configuration > cameras
Type array of object
Required No
Default []
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
cameras items -

Full Configuration > cameras > cameras items
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
+ camera No string No
- alt_camera No array of string No
- alias No string No
- url No string No
- device_tracker No string No
- ptz_camera No string No
- ptz_default_preset No Combination No
- ptz_delay No integer No
- ptz_method No enum (of string) No

Property Full Configuration > cameras > cameras items > camera
Type string
Required Yes

Property Full Configuration > cameras > cameras items > alt_camera
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
alt_camera items -
Full Configuration > cameras > cameras items > alt_camera > alt_camera items
Type string
Required No

Property Full Configuration > cameras > cameras items > alias
Type string
Required No

Property Full Configuration > cameras > cameras items > url
Type string
Required No

Property Full Configuration > cameras > cameras items > device_tracker
Type string
Required No

Property Full Configuration > cameras > cameras items > ptz_camera
Type string
Required No

Property Full Configuration > cameras > cameras items > ptz_default_preset
Type combining
Required No
Additional properties Any type allowed
Default 1
Any of(Option)
item 0
item 1
Property Full Configuration > cameras > cameras items > ptz_default_preset > anyOf > item 0
Type integer
Required No
Restrictions
Minimum ≥ 0
Property Full Configuration > cameras > cameras items > ptz_default_preset > anyOf > item 1
Type string
Required No

Property Full Configuration > cameras > cameras items > ptz_delay
Type integer
Required No
Default 10

Property Full Configuration > cameras > cameras items > ptz_method
Type enum (of string)
Required No
Default "onvif"

Must be one of: * "onvif" * "frigate"

Property Full Configuration > snooze
Type object
Required No
Additional properties Any type allowed
Default {}
Property Pattern Type Deprecated
- snooze_time No integer No

Property Full Configuration > snooze > snooze_time
Type integer
Required No
Default 3600
Restrictions
Minimum ≥ 0

Property Full Configuration > template_path
Type string
Required No
Default "supernotify/templates"

Property Full Configuration > media_path
Type string
Required No
Default "supernotify/media"

Property Full Configuration > media_url_prefix
Type string
Required No
Default "/supernotify/media"

Property Full Configuration > archive
Type object
Required No
Additional properties Any type allowed
Default {"enabled": false}
Property Pattern Type Deprecated
- file_path No string No
- enabled No string No
- file_retention_days No integer No
- mqtt_topic No string No
- mqtt_qos No integer No
- mqtt_retain No string No
- purge_interval No integer No
- event_name No string No
- event_selection No object No
- diagnostics No object No
- debug No string No

Property Full Configuration > archive > file_path
Type string
Required No
Default "supernotify/archive"

Property Full Configuration > archive > enabled
Type string
Required No
Default false

Property Full Configuration > archive > file_retention_days
Type integer
Required No
Default 3
Restrictions
Minimum ≥ 0

Property Full Configuration > archive > mqtt_topic
Type string
Required No

Property Full Configuration > archive > mqtt_qos
Type integer
Required No
Default 0
Restrictions
Minimum ≥ 0

Property Full Configuration > archive > mqtt_retain
Type string
Required No
Default true

Property Full Configuration > archive > purge_interval
Type integer
Required No
Default 60
Restrictions
Minimum ≥ 0

Property Full Configuration > archive > event_name
Type string
Required No
Default "supernotification"

Property Full Configuration > archive > event_selection
Type object
Required No
Additional properties Any type allowed
Default 0
Property Pattern Type Deprecated
- No object No

Property Full Configuration > archive > diagnostics
Type object
Required No
Additional properties Any type allowed
Default 16
Property Pattern Type Deprecated
- No object No

Property Full Configuration > archive > debug
Type string
Required No
Default false

Property Full Configuration > housekeeping
Type object
Required No
Additional properties Any type allowed
Default {}
Property Pattern Type Deprecated
- housekeeping_time No string No
- media_storage_days No integer No

Property Full Configuration > housekeeping > housekeeping_time
Type string
Required No
Default "00:00:01"

Property Full Configuration > housekeeping > media_storage_days
Type integer
Required No
Default 7
Restrictions
Minimum ≥ 0

Property Full Configuration > dupe_check
Type object
Required No
Additional properties Any type allowed
Default {}
Property Pattern Type Deprecated
- ttl No integer No
- size No integer No
- dupe_policy No enum (of string) No

Property Full Configuration > dupe_check > ttl
Type integer
Required No
Default 120
Restrictions
Minimum ≥ 0

Property Full Configuration > dupe_check > size
Type integer
Required No
Default 100
Restrictions
Minimum ≥ 0

Property Full Configuration > dupe_check > dupe_policy
Type enum (of string)
Required No
Default "dupe_policy_message_title_same_or_lower_priority"

Must be one of: * "dupe_policy_message_title_same_or_lower_priority" * "dupe_policy_message_title_same" * "dupe_policy_none"

Property Full Configuration > mobile_discovery
Type boolean
Required No
Default true

Property Full Configuration > recipients_discovery
Type boolean
Required No
Default true

Generated using json-schema-for-humans on 2026-09-01 at 18:26:10 +0000