Generic Transport Adaptor¶

Use this transport to call any action, including 'legacy' Notification action (previously known in Home Assistant as 'service' ) and scripts, REST commands, or anything else Home Assistant can call. It can be used for simple calls, where all you need to do is plug in an action, or as a "toolbox" for more complex needs.

To make life easier, its not entirely a blank slate, and knows about the appropriate data sections for most of the common options - see Known Integrations for more. If you really want it to be a blank slate and override what it knows about domain rules, then use raw: true in the delivery options list.

Notify Actions¶

If an action is in then notify domain, then message,title,target and data will be passed in the Action (Service) Data.

delivery:
  chat_notify:
    transport: generic
    action: notify.custom_chat

Use this deliveries with action calls like this:

    - action: notify.supernotify
      data:
        title: "My Home Notification"
        message: "Notify via custom chat"
        delivery:
            chat_notify:
                data:
                    channel: 3456

This includes support for MQTT Notify Entities. (Supernotify also offers an MQTT Transport Adaptor for direct flexible access to mqtt.publish.)

Selecting Targets¶

By default, Generic will throw all the targets applied in the configuration or action call at the notification, in one flat list of targets, or a single string value if only one target.

Usually you will want to be more specific. If the target is a common built-in type like entity_id or email, then specify this in the target_categories option.

delivery:
  chat_notify:
    transport: generic
    action: notify.custom_chat
    options:
      target_categories: entity_id

If it's not a standard target type, then make one up. In this example, for personal Slack channels, which in this example is called "slack_channel" but can be anything you like so long as it matches up ( you could have separate categories for "slack_group_dm", "slack_user" etc)

recipients:
  - person: person.my_user
    delivery:
      slack:
        target:
           slack_channel: A20H2AN55DX
delivery:
  slack:
      transport: generic
      action: notify.my_slack_service
      options:
           target_categories: slack_channel

This can also be used in a notification call:

    - action: notify.supernotify
      data:
        message: "Notify via slack"
        target:
            slack_channel: #JH838434

Known Integrations¶

Generic isn't completely a blank slate - it knows about the most common integration domains and will build a compatible Action call for them. These have a lot of variation because Home Assistant actions have a lot of variation! Generic Transports handling of these means you can create multi-channel notifications without worrying too much about the variety of data mappings etc.

Input Text Integration¶

input_text can be used with ESP32, APIs and similar to pass text.

Configure a delivery:

delivery:
  esp_screen:
    transport: generic
    action: input_text.set_value
    target: input_text.my_esp32

The message value on the notification will be passed as the value on the data section. See Input Text Integration for more on that.

Other Actions¶

The data supplied will be passed directly as the Action Data, message and title will be dropped as likely to be a problem for switch,script etc integrations.

If you have an action that is not supported, but it requires a similar Home Assistant Action call as one it does support, then the handle_as_domain option can be used.

delivery:
  light_flasher:
  action: flashywashy.flash_me_now
  options:
    handle_as_domain: light

Alternatively, if the custom action call is failing because of data elements from the notification it can't handle, you can control which keys are included, in this example, all keys that don't match the pattern will be dropped (test is made using Python's re.fullmatch):

delivery:
  light_flasher:
  action: zigzag.zig
  options:
    data_keys_select:
      - enabled
      - value
      - zig.*

It also works the other way round, or indeed both together, with excluding, so all data keys are passed, except selected ones

delivery:
  light_flasher:
  action: zigzag.zig
  options:
    data_keys_select:
      exclude:
        - duration
        - volume