Skip to content

Transport Configuration

See the Options Reference for a description of each option.

Default Inclusion

Transport Rank Target Required Inclusion Features
alexa_devices FIRST always default MESSAGE, SPOKEN
alexa_media_player ANY always explicit MESSAGE, SPOKEN
chime ANY optional explicit SOUND
discord ANY always explicit MESSAGE, TITLE, IMAGES, SNAPSHOT_IMAGE
email ANY always default MESSAGE, TITLE, IMAGES, ACTIONS, TEMPLATE_FILE, SNAPSHOT_IMAGE
generic ANY optional explicit MESSAGE, TITLE
gotify ANY never explicit MESSAGE, TITLE, IMAGES, SNAPSHOT_IMAGE
html5 FIRST always default MESSAGE, TITLE, IMAGES, ACTIONS, SNAPSHOT_IMAGE
kodi ANY always explicit MESSAGE, TITLE, IMAGES, SNAPSHOT_IMAGE
lametric ANY never explicit MESSAGE, TITLE
matrix ANY always explicit MESSAGE, TITLE, IMAGES, SNAPSHOT_IMAGE
media ANY always explicit IMAGES, VIDEO, SNAPSHOT_IMAGE, SOUND
mobile_push ANY always default MESSAGE, TITLE, IMAGES, VIDEO, ACTIONS, SNAPSHOT_IMAGE
mqtt ANY optional explicit MESSAGE
notify_entity LAST always default MESSAGE, TITLE
ntfy ANY never explicit MESSAGE, TITLE, IMAGES, ACTIONS, SNAPSHOT_IMAGE
persistent ANY never explicit MESSAGE, TITLE
pushover ANY never explicit MESSAGE, TITLE, IMAGES, SNAPSHOT_IMAGE
sms ANY always default MESSAGE, TITLE
telegram ANY always explicit MESSAGE, TITLE, IMAGES, ACTIONS, SNAPSHOT_IMAGE
tts FIRST always explicit MESSAGE, SPOKEN

Target Categories

Which target categories each transport accepts - see Targets for how to qualify a target with one. A transport with none listed relies entirely on its own name, its deliveries' names, or a delivery's target_categories option (e.g. generic).

Transport Target Categories Unique Targets
alexa_devices entity_id (domain=notify, platform=alexa_devices), entity_id (domain=group) True
alexa_media_player entity_id (domain=media_player, platform=alexa_media) True
chime entity_id (domain=switch/script/group/rest_command/siren/media_player), device_id False
discord discord_channel False
email email True
generic - False
gotify - False
html5 entity_id (domain=notify, platform=html5) True
kodi entity_id (domain=media_player) False
lametric - False
matrix matrix_room False
media entity_id (domain=media_player) False
mobile_push mobile_app_id True
mqtt topic False
notify_entity entity_id (domain=notify) True
ntfy - False
persistent - False
pushover - False
sms phone True
telegram - False
tts entity_id (domain=media_player), mobile_app_id False

Default Options

Transport data_keys_select default_title device_discovery device_domain device_manufacturer_select device_model_select handle_as_domain jpeg_opts media_auto_pause message_usage mode png_opts preheader_blank preheader_length raw sender_name simplify_text strict_template strip_urls target_select tts_entity_id unique_targets
alexa_devices N/A N/A N/A N/A N/A N/A N/A N/A N/A STANDARD N/A N/A N/A N/A N/A N/A True N/A True ['group\.[a-z0-9_]+', '^notify\.[A-Za-z0-9_]+$'] N/A True
alexa_media_player N/A N/A N/A N/A N/A N/A N/A N/A True STANDARD N/A N/A N/A N/A N/A N/A True N/A True ['^media_player\.[A-Za-z0-9_]+$'] N/A True
chime N/A N/A True ['alexa_devices'] N/A {'exclude': ['Speaker Group']} N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A ['(switch|script|group|rest_command|siren|media_player)\.[A-Za-z0-9_]+', '^[0-9a-f]{32}$'] N/A N/A
discord N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A
email N/A Home Assistant Notification N/A N/A N/A N/A N/A {'progressive': 'true', 'optimize': 'true'} N/A STANDARD direct {'optimize': 'true'} ͏‌  100 N/A Home Assistant False False False N/A N/A True
generic - N/A N/A N/A N/A N/A - N/A N/A STANDARD N/A N/A N/A N/A False N/A False N/A False N/A N/A N/A
gotify N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A
html5 N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A ['^notify\.[A-Za-z0-9_]+$'] N/A True
kodi N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A ['^media_player\.[A-Za-z0-9_]+$'] N/A N/A
lametric N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A
matrix N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A
media N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A ['^media_player\.[A-Za-z0-9_]+$'] N/A N/A
mobile_push - N/A False ['mobile_app'] N/A N/A N/A N/A N/A STANDARD N/A N/A N/A N/A N/A N/A False N/A False N/A N/A True
mqtt N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A
notify_entity N/A N/A N/A N/A N/A N/A N/A N/A N/A STANDARD N/A N/A N/A N/A N/A N/A False N/A False ['^notify\.[A-Za-z0-9_]+$'] N/A True
ntfy N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A
persistent N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A
pushover N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A
sms N/A N/A N/A N/A N/A N/A N/A N/A N/A COMBINE_TITLE N/A N/A N/A N/A N/A N/A True N/A False N/A N/A True
telegram N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A
tts N/A N/A False ['mobile_app'] {'exclude': ['Apple']} N/A N/A N/A N/A STANDARD N/A N/A N/A N/A N/A N/A True N/A True ['^media_player\.[A-Za-z0-9_]+$', '(notify\.)?mobile_app_[a-z0-9_]+'] tts.home_assistant_cloud N/A