Actionable Notifications Subflow for Android #311

zachowj · 2020-12-19T07:48:06Z

zachowj
Dec 19, 2020
Maintainer

Actionable Notifications Subflow for Android

Questions and comments here.

scooper86 · 2021-03-30T20:25:26Z

scooper86
Mar 30, 2021

this is really cool, could you possibly add the ability to add attachments so images can be included in a notification?

0 replies

cooperised · 2021-04-16T11:01:49Z

cooperised
Apr 16, 2021

Could there be an option to add arbitrary data to the data: portion of the service call? For example in one of my existing automations that I'd like to replicate in Node-RED, I currently use persistent: true and ttl: 0 in addition to the sticky property to create a notification that can't be dismissed. Adding all these as separate options would be fine too.

8 replies

sstratoti Apr 16, 2021

In the docs for the companion app, under iOS it states:

action_data: # Anything passed in action_data will get echoed back to Home Assistant.

There is also an action_data for android. Try that? It doesn't explicitly say, but I imagine they'd work the same.

cooperised Apr 16, 2021

I don't think we're talking about the same thing. I was previously creating actionable, non-dismissable "critical notifications" using HA automations with YAMM like this:

title: Garage Heat
message: Garage heaters are currently on.
data:
  tag: garage_heat
  sticky: true
  persistent: true
  ttl: 0
  priority: high
  actions:
    - action: garage_heat_off
      title: Switch off

The code in this subflow that generates the service call to HA looks like this:

msg.payload = {
    service,
    data: {
        title: env.get('title'),
        message: env.get('message'),
        data: {
            tag: flow.get('notificationTag'),
            actions,
            color: env.get("color"),
            group: env.get("group"),
            sticky: env.get("sticky"),
            timeout: env.get("timeout"),
            icon: env.get("icon")
        }
    }
};

There is no way to get anything else into the body of the service call (e.g. the priority, ttl or persistent fields from above) without editing this code. Doing so is pretty trivial though, so I've added three extra fields to the UI and three extra lines in the code and I can now set these properties no problem.

cooperised Apr 16, 2021

Forgot to add, I'll happily fork and create a PR if it would be helpful.

zachowj Apr 17, 2021
Maintainer Author

Contributions always welcomed

jj-uk Dec 20, 2022

@cooperised Did this ever get added? It's needed so that the notification arrives if the device is locked, without it, i think the notification only arrives when the phone is next unlocked.

sstratoti · 2021-04-16T17:13:55Z

sstratoti
Apr 16, 2021

Also, to comment on this subflow - this has opened up a whole new world for me. I'm working to rewrite it for iOS notifications, and it'll greatly simplify my flows. Thanks for the example!

3 replies

poldim Jul 20, 2021

@sstratoti How's your progress coming along for this? I imported the subflow and it seems to send the notification to ios without problems. However, none of the actionable responses/selections are making their way back out of the subflow. NR is getting them as I'm watching the mobile_app_notification_action events.

bls0n Jan 13, 2022

Did you ever successfully create an ios version? I haven't had success yet and would greatly appreciate ios-specific code if you're willing to share.

bls0n Jan 13, 2022

Found it on reddit. Thanks!
https://www.reddit.com/r/homeassistant/comments/naoe4e/nodered_20215_ios_actionable_notifications_subflow/

aquavass · 2021-05-15T03:39:33Z

aquavass
May 15, 2021

Hi there, great work... very impressive.

I'm currently using PUSH OVER messaging service which works well as I am able to send photo snapshots which I believe is not available for android push notifications but am looking to replace all other system messages outside alerts to send actionable messages using your solution... its awesome.

Question, is it possible to execute a function node to set the payload title, message, action title 1 etc? I have tested this but does not work as the values don't appear to pass through to the actionable subflow? Do I have my syntax wrong?

Thanks

11 replies

zachowj Jan 27, 2022
Maintainer Author

I believe the latest version works, it's the one in the gist

https://gist.github.com/zachowj/a594c63e2d788d89d17fc93d01905042

rossco555 Sep 14, 2022

I get an error "Call-service error. extra keys not allowed @ data['actions']" when I try that example block above.

(For completeness, I am doing this via a function block but assume that makes no material difference:)

msg.actionable = {
    "title": "Washing Machine Done",
    "message": "override message",
    "actions": [
        null,
        {
            "title": "title 2"
        }
    ]
}

return msg

Also, how do you use this approach - assuming I can get it working - and override service? Does that just sit as a peer to title in the object?

zachowj Sep 14, 2022
Maintainer Author

actions should be under data

msg.actionable = {
  message: "override message",
  data: {
    actions: [...]
  }
}

Doesn't look like I added the ability to override services

rossco555 Sep 15, 2022

Ok, thanks. Got it working as I saw that structure somewhere else.

To override service, I modified line 5 of 'create service call' to:

const services = msg.service || env.get('service');

(I think I had to put outside of the actionable object to avoid the same error in my original post... haven't looked into it in detail but this is maybe because your function block packages up everything it sees inside actionable and sends it off to the HA call service node, which throws the error?)

rossco555 Sep 15, 2022

For anyone interested re my previous line of posts, I wanted to override service from the message object because I want to semi-dynamically determine that. I have created a "Notification" wrapper for "Actionable Notification" that looks at a series of input_selects in Home Assistant for different "types" (/categories/classes) of notification where I can choose any combination of three notifiable devices (my phone, my wife's phone, and a wall tablet). This means if my wife gets annoyed with "camera" alerts for example, she can disable those notifications without just disabling everything in Android as she has in the past (and so missing washing machine "appliance" alerts she should be tending to - I shouldn't joke in a PC world).

The wrapper, for anyone interested is a subflow as below:

[
    {
        "id": "6dc0247c.d7210c",
        "type": "subflow",
        "name": "Actionable Notification",
        "info": "Android actionable notification v1.0.0\n\n[Documentation](https://zachowj.github.io/node-red-contrib-home-assistant-websocket/cookbook/actionable-notifications-subflow-for-android.html)\n\nRG 3/5/22: added image in myself\n",
        "category": "HA Actions",
        "in": [
            {
                "x": 84,
                "y": 80,
                "wires": [
                    {
                        "id": "9d85d137.fe487"
                    }
                ]
            }
        ],
        "out": [
            {
                "x": 1188,
                "y": 128,
                "wires": [
                    {
                        "id": "974bd48d.c253e8",
                        "port": 0
                    }
                ]
            },
            {
                "x": 1188,
                "y": 176,
                "wires": [
                    {
                        "id": "974bd48d.c253e8",
                        "port": 1
                    }
                ]
            },
            {
                "x": 1188,
                "y": 224,
                "wires": [
                    {
                        "id": "974bd48d.c253e8",
                        "port": 2
                    }
                ]
            },
            {
                "x": 964,
                "y": 240,
                "wires": [
                    {
                        "id": "5bc7345c.07b1cc",
                        "port": 1
                    }
                ]
            }
        ],
        "env": [
            {
                "name": "service",
                "type": "str",
                "value": "",
                "ui": {
                    "label": {
                        "en-US": "Notify Service"
                    },
                    "type": "input",
                    "opts": {
                        "types": [
                            "str"
                        ]
                    }
                }
            },
            {
                "name": "title",
                "type": "str",
                "value": "",
                "ui": {
                    "label": {
                        "en-US": "Title"
                    },
                    "type": "input",
                    "opts": {
                        "types": [
                            "str"
                        ]
                    }
                }
            },
            {
                "name": "message",
                "type": "str",
                "value": "",
                "ui": {
                    "label": {
                        "en-US": "Message"
                    },
                    "type": "input",
                    "opts": {
                        "types": [
                            "str"
                        ]
                    }
                }
            },
            {
                "name": "action1Title",
                "type": "str",
                "value": "",
                "ui": {
                    "label": {
                        "en-US": "Action 1 Title"
                    },
                    "type": "input",
                    "opts": {
                        "types": [
                            "str"
                        ]
                    }
                }
            },
            {
                "name": "action1Uri",
                "type": "str",
                "value": "",
                "ui": {
                    "label": {
                        "en-US": "Action 1 URI (optional)"
                    },
                    "type": "input",
                    "opts": {
                        "types": [
                            "str"
                        ]
                    }
                }
            },
            {
                "name": "action2Title",
                "type": "str",
                "value": "",
                "ui": {
                    "label": {
                        "en-US": "Action 2 Title"
                    },
                    "type": "input",
                    "opts": {
                        "types": [
                            "str"
                        ]
                    }
                }
            },
            {
                "name": "action2Uri",
                "type": "str",
                "value": "",
                "ui": {
                    "label": {
                        "en-US": "Action 2 URI (optional)"
                    },
                    "type": "input",
                    "opts": {
                        "types": [
                            "str"
                        ]
                    }
                }
            },
            {
                "name": "action3Title",
                "type": "str",
                "value": "",
                "ui": {
                    "label": {
                        "en-US": "Action 3 Title"
                    },
                    "type": "input",
                    "opts": {
                        "types": [
                            "str"
                        ]
                    }
                }
            },
            {
                "name": "action3Uri",
                "type": "str",
                "value": "",
                "ui": {
                    "label": {
                        "en-US": "Action 3 URI (optional)"
                    },
                    "type": "input",
                    "opts": {
                        "types": [
                            "str"
                        ]
                    }
                }
            },
            {
                "name": "userInfo",
                "type": "bool",
                "value": "false",
                "ui": {
                    "label": {
                        "en-US": "Populate User Information"
                    },
                    "type": "checkbox"
                }
            },
            {
                "name": "sticky",
                "type": "bool",
                "value": "false",
                "ui": {
                    "label": {
                        "en-US": "Sticky"
                    },
                    "type": "checkbox"
                }
            },
            {
                "name": "group",
                "type": "str",
                "value": "None",
                "ui": {
                    "label": {
                        "en-US": "Group"
                    },
                    "type": "select",
                    "opts": {
                        "opts": [
                            {
                                "l": {
                                    "en-US": "None"
                                },
                                "v": ""
                            },
                            {
                                "l": {
                                    "en-US": "Cameras"
                                },
                                "v": "camera"
                            },
                            {
                                "l": {
                                    "en-US": "Security"
                                },
                                "v": "security"
                            },
                            {
                                "l": {
                                    "en-US": "Garage"
                                },
                                "v": "garage"
                            },
                            {
                                "l": {
                                    "en-US": "Laundry Room"
                                },
                                "v": "laundry_room"
                            }
                        ]
                    }
                }
            },
            {
                "name": "color",
                "type": "str",
                "value": "",
                "ui": {
                    "label": {
                        "en-US": "Color"
                    },
                    "type": "input",
                    "opts": {
                        "types": [
                            "str"
                        ]
                    }
                }
            },
            {
                "name": "timeout",
                "type": "num",
                "value": "",
                "ui": {
                    "label": {
                        "en-US": "Timeout"
                    },
                    "type": "input",
                    "opts": {
                        "types": [
                            "num"
                        ]
                    }
                }
            },
            {
                "name": "icon",
                "type": "str",
                "value": "",
                "ui": {
                    "label": {
                        "en-US": "Icon"
                    },
                    "type": "input",
                    "opts": {
                        "types": [
                            "str"
                        ]
                    }
                }
            },
            {
                "name": "image_uri",
                "type": "str",
                "value": ""
            }
        ],
        "meta": {},
        "color": "#46B1EF",
        "outputLabels": [
            "Action 1",
            "Action 2",
            "Action 3",
            "Cleared"
        ],
        "icon": "font-awesome/fa-mobile-phone",
        "status": {
            "x": 244,
            "y": 272,
            "wires": [
                {
                    "id": "204dbcfc.144ae4",
                    "port": 0
                }
            ]
        }
    },
    {
        "id": "f9e57204.71076",
        "type": "function",
        "z": "6dc0247c.d7210c",
        "name": "create service call",
        "func": "msg._originalPayload = msg.payload;\nflow.set('latestMessage', msg);\n\n// const services = env.get('service');\nconst services = msg.service || env.get('service');\nif(!services) {\n    node.status({\n        text: 'no services defined',\n        shape: 'ring',\n        fill: 'red'\n    });\n    return;    \n}\n\nconst actions = [1, 2, 3].reduce((acc, i) => {\n    const name = `action${i}`\n    const id = flow.get(`${name}Id`);\n    const title = getActionProperty(i, \"title\") ?? env.get(`${name}Title`);\n    const uri = getActionProperty(i, \"uri\") ?? env.get(`${name}Uri`);\n    const action = uri.length ? 'URI' : title ? id : undefined;\n\n    acc.push({ action, title, uri });\n\n    return acc;\n}, []);\n\nconst tag = flow.get('notificationTag');\nconst data = mergeDeep({\n        title: env.get('title'),\n        message: env.get('message'),\n        data: {\n            tag,\n            color: env.get(\"color\"),\n            group: env.get(\"group\"),\n            sticky: env.get(\"sticky\"),\n            timeout: env.get(\"timeout\"),\n            icon: env.get(\"icon\"),\n            image: env.get(\"image_uri\")\n        },\n    },    \n    msg.actionable,    \n    {data: {actions}},\n);\n\nif(tag !== data?.data?.tag) {\n    flow.set('notificationTag', data?.data?.tag);\n}\n\nservices.trim().split(/,\\s*/).forEach(service => {\n    if(!service) return;\n    \n    msg.payload = {\n        service,\n        data,\n    };\n    node.send(msg);\n});\n\nnode.done();\n\nfunction getActionProperty(index, prop) {\n    const i = index - 1;\n\n    return msg?.actionable?.data?.actions?.[i]?.[prop];\n}\n\n/**\n * Simple object check.\n * @param item\n * @returns {boolean}\n */\nfunction isObject(item) {\n    return (item && typeof item === 'object' && !Array.isArray(item));\n}\n\n/**\n * Deep merge two objects.\n * @param target\n * @param sources\n */\nfunction mergeDeep(target, ...sources) {\n    if (!sources.length) return target;\n    const source = sources.shift();\n\n    if (isObject(target) && isObject(source)) {\n        for (const key in source) {\n            if (isObject(source[key])) {\n                if (!target[key]) Object.assign(target, { [key]: {} });\n                mergeDeep(target[key], source[key]);\n            } else {\n                Object.assign(target, { [key]: source[key] });\n            }\n        }\n    }\n\n    return mergeDeep(target, ...sources);\n}\n",
        "outputs": 1,
        "noerr": 0,
        "initialize": "const randomId = () => Math.random().toString(36).replace(/[^a-z]+/g, '').substr(0, 5);\n\n[1,2,3].forEach(i => {\n    flow.set(`action${i}Id`, `action${i}_${randomId()}`);\n})\n\n\nflow.set('notificationTag', `${env.get('title')}_${randomId()}`);",
        "finalize": "",
        "libs": [],
        "x": 298,
        "y": 80,
        "wires": [
            [
                "368c9723.5876f8"
            ]
        ]
    },
    {
        "id": "974bd48d.c253e8",
        "type": "switch",
        "z": "6dc0247c.d7210c",
        "name": "which action?",
        "property": "eventData.event.action",
        "propertyType": "msg",
        "rules": [
            {
                "t": "eq",
                "v": "action1Id",
                "vt": "flow"
            },
            {
                "t": "eq",
                "v": "action2Id",
                "vt": "flow"
            },
            {
                "t": "eq",
                "v": "action3Id",
                "vt": "flow"
            }
        ],
        "checkall": "true",
        "repair": false,
        "outputs": 3,
        "x": 1024,
        "y": 176,
        "wires": [
            [],
            [],
            []
        ]
    },
    {
        "id": "204dbcfc.144ae4",
        "type": "status",
        "z": "6dc0247c.d7210c",
        "name": "",
        "scope": [
            "f9e57204.71076",
            "5bc7345c.07b1cc",
            "a622c92a.2d9898",
            "368c9723.5876f8"
        ],
        "x": 124,
        "y": 272,
        "wires": [
            []
        ]
    },
    {
        "id": "5bc7345c.07b1cc",
        "type": "function",
        "z": "6dc0247c.d7210c",
        "name": "build message",
        "func": "const latestMessage = flow.get('latestMessage');\nconst event = msg.payload.event;\n\nlatestMessage.eventData = msg.payload;\nlatestMessage.payload = latestMessage._originalPayload;\ndelete latestMessage._originalPayload;\ndelete latestMessage.actionable;\n\nif(env.get('userInfo')) {\n    const userData = msg.userData.find(u => u.id === msg.payload.context.user_id);\n    latestMessage.userData = userData;\n}\n\nif(msg.event_type === 'mobile_app_notification_cleared') {\n    node.status({\n        text: `cleared at: ${getPrettyDate()}`,\n        shape: 'dot',\n        fill: 'blue'\n    });\n    \n    return [null, latestMessage];\n}\n\nconst index = [1,2,3].find(i => event[`action_${i}_key`] === event.action);\nnode.status({\n    text: `${event[`action_${index}_title`]} at: ${getPrettyDate()}`,\n    shape: 'dot',\n    fill: 'green'\n});\n\nreturn latestMessage;\n\n\nfunction getPrettyDate() {\n    return new Date().toLocaleDateString('en-US', {\n        month: 'short',\n        day: 'numeric',\n        hour12: false,\n        hour: 'numeric',\n        minute: 'numeric',\n    });\n}",
        "outputs": 2,
        "noerr": 0,
        "initialize": "",
        "finalize": "",
        "libs": [],
        "x": 832,
        "y": 176,
        "wires": [
            [
                "974bd48d.c253e8"
            ],
            []
        ]
    },
    {
        "id": "8d3bdc0c.37493",
        "type": "switch",
        "z": "6dc0247c.d7210c",
        "name": "belongs here?",
        "property": "payload.event.tag",
        "propertyType": "msg",
        "rules": [
            {
                "t": "eq",
                "v": "notificationTag",
                "vt": "flow"
            }
        ],
        "checkall": "true",
        "repair": false,
        "outputs": 1,
        "x": 432,
        "y": 176,
        "wires": [
            [
                "83ad2004.d04d"
            ]
        ]
    },
    {
        "id": "271e4479.b9249c",
        "type": "ha-api",
        "z": "6dc0247c.d7210c",
        "name": "get user info",
        "server": "a0706da5e5446e30",
        "version": 1,
        "debugenabled": false,
        "protocol": "websocket",
        "method": "get",
        "path": "",
        "data": "{\"type\": \"config/auth/list\"}",
        "dataType": "json",
        "responseType": "json",
        "outputProperties": [
            {
                "property": "userData",
                "propertyType": "msg",
                "value": "",
                "valueType": "results"
            }
        ],
        "x": 822,
        "y": 128,
        "wires": [
            [
                "5bc7345c.07b1cc"
            ]
        ]
    },
    {
        "id": "3618f055.6909a",
        "type": "server-events",
        "z": "6dc0247c.d7210c",
        "name": "mobile_app_notification_cleared",
        "server": "a0706da5e5446e30",
        "version": 1,
        "event_type": "mobile_app_notification_cleared",
        "exposeToHomeAssistant": false,
        "haConfig": [
            {
                "property": "name",
                "value": ""
            },
            {
                "property": "icon",
                "value": ""
            }
        ],
        "waitForRunning": false,
        "outputProperties": [
            {
                "property": "payload",
                "propertyType": "msg",
                "value": "",
                "valueType": "eventData"
            },
            {
                "property": "topic",
                "propertyType": "msg",
                "value": "$outputData(\"eventData\").event_type",
                "valueType": "jsonata"
            },
            {
                "property": "event_type",
                "propertyType": "msg",
                "value": "$outputData(\"eventData\").event_type",
                "valueType": "jsonata"
            }
        ],
        "x": 194,
        "y": 224,
        "wires": [
            [
                "8d3bdc0c.37493"
            ]
        ]
    },
    {
        "id": "83ad2004.d04d",
        "type": "switch",
        "z": "6dc0247c.d7210c",
        "name": "fetch user info?",
        "property": "userInfo",
        "propertyType": "env",
        "rules": [
            {
                "t": "true"
            },
            {
                "t": "else"
            }
        ],
        "checkall": "true",
        "repair": false,
        "outputs": 2,
        "x": 624,
        "y": 176,
        "wires": [
            [
                "271e4479.b9249c"
            ],
            [
                "5bc7345c.07b1cc"
            ]
        ]
    },
    {
        "id": "9d85d137.fe487",
        "type": "switch",
        "z": "6dc0247c.d7210c",
        "name": "",
        "property": "clear_notification",
        "propertyType": "msg",
        "rules": [
            {
                "t": "null"
            },
            {
                "t": "nnull"
            }
        ],
        "checkall": "true",
        "repair": false,
        "outputs": 2,
        "x": 143,
        "y": 80,
        "wires": [
            [
                "f9e57204.71076"
            ],
            [
                "a622c92a.2d9898"
            ]
        ],
        "l": false
    },
    {
        "id": "a622c92a.2d9898",
        "type": "function",
        "z": "6dc0247c.d7210c",
        "name": "create clear notification",
        "func": "const services = env.get('service');\nif(!services) {\n    node.status({\n        text: 'no services defined',\n        shape: 'ring',\n        fill: 'red'\n    });\n    return;    \n}\n\nservices.trim().split(/,\\s*/).forEach(service => {\n    if(!service) return;\n    \n    msg.payload = {\n        service,\n        data: {\n            message: \"clear_notification\",\n            data: {\n                tag: flow.get('notificationTag'),\n            }\n        }\n    };\n    node.send(msg);\n});\n\nnode.status({text: \"cleared\"});\nnode.done();",
        "outputs": 1,
        "noerr": 0,
        "initialize": "",
        "finalize": "",
        "libs": [],
        "x": 318,
        "y": 128,
        "wires": [
            [
                "368c9723.5876f8"
            ]
        ]
    },
    {
        "id": "9bfe567c.3d10c8",
        "type": "server-events",
        "z": "6dc0247c.d7210c",
        "name": "mobile_app_notification_action",
        "server": "a0706da5e5446e30",
        "version": 1,
        "event_type": "mobile_app_notification_action",
        "exposeToHomeAssistant": false,
        "haConfig": [
            {
                "property": "name",
                "value": ""
            },
            {
                "property": "icon",
                "value": ""
            }
        ],
        "waitForRunning": false,
        "outputProperties": [
            {
                "property": "payload",
                "propertyType": "msg",
                "value": "",
                "valueType": "eventData"
            },
            {
                "property": "topic",
                "propertyType": "msg",
                "value": "$outputData(\"eventData\").event_type",
                "valueType": "jsonata"
            },
            {
                "property": "event_type",
                "propertyType": "msg",
                "value": "$outputData(\"eventData\").event_type",
                "valueType": "jsonata"
            }
        ],
        "x": 194,
        "y": 176,
        "wires": [
            [
                "8d3bdc0c.37493"
            ]
        ]
    },
    {
        "id": "368c9723.5876f8",
        "type": "api-call-service",
        "z": "6dc0247c.d7210c",
        "name": "",
        "server": "a0706da5e5446e30",
        "version": 5,
        "debugenabled": false,
        "domain": "notify",
        "areaId": [],
        "deviceId": [],
        "entityId": [],
        "data": "",
        "dataType": "json",
        "mergeContext": "",
        "mustacheAltTags": false,
        "outputProperties": [],
        "queue": "all",
        "x": 550,
        "y": 80,
        "wires": [
            []
        ]
    },
    {
        "id": "a0706da5e5446e30",
        "type": "server",
        "name": "Home Assistant",
        "version": 4,
        "addon": false,
        "rejectUnauthorizedCerts": true,
        "ha_boolean": "y|yes|true|on|home|open",
        "connectionDelay": true,
        "cacheJson": true,
        "heartbeat": false,
        "heartbeatInterval": "30",
        "areaSelector": "friendlyName",
        "deviceSelector": "friendlyName",
        "entitySelector": "friendlyName",
        "statusSeparator": "at: ",
        "statusYear": "hidden",
        "statusMonth": "short",
        "statusDay": "numeric",
        "statusHourCycle": "h23",
        "statusTimeFormat": "h:m"
    },
    {
        "id": "d7045db4775debcf",
        "type": "subflow",
        "name": "Notifications",
        "info": "",
        "category": "",
        "in": [
            {
                "x": 40,
                "y": 40,
                "wires": [
                    {
                        "id": "fb5ae0dc1a6ef6b2"
                    }
                ]
            }
        ],
        "out": [
            {
                "x": 920,
                "y": 40,
                "wires": [
                    {
                        "id": "2149411044a9dab3",
                        "port": 0
                    }
                ]
            },
            {
                "x": 940,
                "y": 100,
                "wires": [
                    {
                        "id": "2149411044a9dab3",
                        "port": 1
                    }
                ]
            },
            {
                "x": 940,
                "y": 160,
                "wires": [
                    {
                        "id": "2149411044a9dab3",
                        "port": 2
                    }
                ]
            },
            {
                "x": 920,
                "y": 220,
                "wires": [
                    {
                        "id": "2149411044a9dab3",
                        "port": 3
                    }
                ]
            }
        ],
        "env": [
            {
                "name": "type",
                "type": "str",
                "value": "general"
            },
            {
                "name": "service",
                "type": "str",
                "value": ""
            },
            {
                "name": "title",
                "type": "str",
                "value": ""
            },
            {
                "name": "message",
                "type": "str",
                "value": ""
            },
            {
                "name": "action1Title",
                "type": "str",
                "value": ""
            },
            {
                "name": "action1Uri",
                "type": "str",
                "value": ""
            },
            {
                "name": "action2Title",
                "type": "str",
                "value": ""
            },
            {
                "name": "action2Uri",
                "type": "str",
                "value": ""
            },
            {
                "name": "action3Title",
                "type": "str",
                "value": ""
            },
            {
                "name": "action3Uri",
                "type": "str",
                "value": ""
            },
            {
                "name": "userInfo",
                "type": "bool",
                "value": "false"
            },
            {
                "name": "sticky",
                "type": "bool",
                "value": "false"
            },
            {
                "name": "group",
                "type": "str",
                "value": "None"
            },
            {
                "name": "color",
                "type": "str",
                "value": ""
            },
            {
                "name": "timeout",
                "type": "str",
                "value": ""
            },
            {
                "name": "icon",
                "type": "str",
                "value": ""
            },
            {
                "name": "image_uri",
                "type": "str",
                "value": ""
            }
        ],
        "meta": {},
        "color": "#A6BBCF",
        "outputLabels": [
            "Action 1",
            "Action 2",
            "Action 3",
            "Cleared"
        ],
        "icon": "font-awesome/fa-commenting-o",
        "status": {
            "x": 280,
            "y": 280,
            "wires": [
                {
                    "id": "33d4706215dfe888",
                    "port": 0
                }
            ]
        }
    },
    {
        "id": "2149411044a9dab3",
        "type": "subflow:6dc0247c.d7210c",
        "z": "d7045db4775debcf",
        "name": "notify",
        "env": [
            {
                "name": "action2Title",
                "value": " ",
                "type": "str"
            },
            {
                "name": "action3Title",
                "value": " ",
                "type": "str"
            },
            {
                "name": "group",
                "value": "",
                "type": "str"
            }
        ],
        "x": 750,
        "y": 120,
        "wires": [
            [],
            [],
            [],
            []
        ]
    },
    {
        "id": "fb5ae0dc1a6ef6b2",
        "type": "api-current-state",
        "z": "d7045db4775debcf",
        "name": "notifications permissible?",
        "server": "a0706da5e5446e30",
        "version": 3,
        "outputs": 2,
        "halt_if": "on",
        "halt_if_type": "str",
        "halt_if_compare": "is",
        "entity_id": "binary_sensor.notifications_permissive",
        "state_type": "str",
        "blockInputOverrides": false,
        "outputProperties": [
            {
                "property": "payload",
                "propertyType": "msg",
                "value": "",
                "valueType": "entityState"
            },
            {
                "property": "data",
                "propertyType": "msg",
                "value": "",
                "valueType": "entity"
            }
        ],
        "for": "0",
        "forType": "num",
        "forUnits": "minutes",
        "override_topic": false,
        "state_location": "payload",
        "override_payload": "msg",
        "entity_location": "data",
        "override_data": "msg",
        "x": 210,
        "y": 40,
        "wires": [
            [
                "b7c8986d2071d993"
            ],
            []
        ]
    },
    {
        "id": "b7c8986d2071d993",
        "type": "api-get-history",
        "z": "d7045db4775debcf",
        "name": "get all notification recipient settings",
        "server": "a0706da5e5446e30",
        "version": 0,
        "startdate": "",
        "enddate": "",
        "entityid": "_notification_recipients",
        "entityidtype": "includes",
        "useRelativeTime": true,
        "relativeTime": "0s",
        "flatten": true,
        "output_type": "array",
        "output_location_type": "msg",
        "output_location": "payload",
        "x": 240,
        "y": 120,
        "wires": [
            [
                "55547da98ecaba63"
            ]
        ]
    },
    {
        "id": "55547da98ecaba63",
        "type": "function",
        "z": "d7045db4775debcf",
        "name": "determine recipient services",
        "func": "// determine the recipient services for the provided notificationType\n\nvar recipientSettingsObj = {};\n\nvar servicesObj = {\n    MyAir: 'mobile_app_pic8gs8',\n    Ross: 'mobile_app_ross_s_pixel_4',\n    Wife: 'mobile_app_wife_s_pixel_6',\n}\n\nmsg.payload.forEach(item => {\n    settingName = item[0].entity_id\n                    .replace('input_select.', '')\n                    .replace('_notification_recipients', '');\n    recipientSettingsObj[settingName] = item[0].state;\n})\n\nmsg.payload = \"actionable\" // no effect, visual only\n\nmsg.service = (recipientSettingsObj[msg.type] ?? '')\n                .split(', ')\n                .map(name => servicesObj[name] ?? null)\n                .join(',')\n\nreturn msg;",
        "outputs": 1,
        "noerr": 0,
        "initialize": "",
        "finalize": "",
        "libs": [],
        "x": 540,
        "y": 120,
        "wires": [
            [
                "2149411044a9dab3",
                "1668fe9b64bdb625"
            ]
        ]
    },
    {
        "id": "591943eced056847",
        "type": "comment",
        "z": "d7045db4775debcf",
        "name": "// notifications wrapper to allow custom routing (or disabling) of notifications by type",
        "info": "",
        "x": 390,
        "y": 220,
        "wires": []
    },
    {
        "id": "1668fe9b64bdb625",
        "type": "debug",
        "z": "d7045db4775debcf",
        "name": "debug 20",
        "active": true,
        "tosidebar": true,
        "console": false,
        "tostatus": false,
        "complete": "true",
        "targetType": "full",
        "statusVal": "",
        "statusType": "auto",
        "x": 760,
        "y": 340,
        "wires": []
    },
    {
        "id": "33d4706215dfe888",
        "type": "status",
        "z": "d7045db4775debcf",
        "name": "",
        "scope": [
            "2149411044a9dab3"
        ],
        "x": 160,
        "y": 280,
        "wires": [
            []
        ]
    },
    {
        "id": "d08b79becec6a317",
        "type": "comment",
        "z": "d7045db4775debcf",
        "name": "// added image ('image_uri', intentionally lowercase for identification) as an env var",
        "info": "",
        "x": 710,
        "y": 540,
        "wires": []
    },
    {
        "id": "b7323155b6dd489a",
        "type": "comment",
        "z": "d7045db4775debcf",
        "name": "// modified 'create service call' function, line 5 (see details)",
        "info": "const services = msg.actionable.data.service || env.get('service');",
        "x": 630,
        "y": 580,
        "wires": []
    },
    {
        "id": "30a6497ece70dab5",
        "type": "comment",
        "z": "d7045db4775debcf",
        "name": "My mods to Actionable Notification (v1.0.0)",
        "info": "",
        "x": 580,
        "y": 500,
        "wires": []
    }
]

My HA input_selects are of the example form below, and all finish with _notification_recipients so they are picked up by the wrapper to reconcile the notification type against... and then determine the recipients' names.

appliance_notification_recipients:
  name: Appliance Related Notification Recipients
  icon: mdi:account-multiple-check
  options:
    - Ross, Wife
    - Ross
    - Wife
    - MyAir
    - Ross, Wife, MyAir
    - Ross, MyAir
    - Wife, MyAir
    - None

I have hard-coded the logic to translate the input_select options "Ross", "Wife", "MyAir" into service names as can be seen in my code. Obviously there are ways to avoid this (or define in HA) but I figured that was even further over engineering.

Whenever I have the need for an Actionable Notification, I hydrate my own "Notification" node with a function node I call "prepare message" and it has a structure like this:

msg.actionable = {
    title: "Clothes Dryer Done",
    message: "bla",
    data: {
        actions: [
            null,
            {
                "title": "Action 2 Title"
            }
        ]
    }
}

msg.type = 'appliance'
msg.service = 'mobile_app_ross_s_pixel_4'

return msg

Take it or leave it, just thought I would share.

sanderlv · 2021-05-16T18:57:05Z

sanderlv
May 16, 2021

What and where do I need to change when I have translated the message? I do not see any output in my debug node
. This is not my final flow but am testing.

EDIT: I copied again, now it's working.

1 tip and 1 question however.

Can you please make the examples with a separate sub-flow if possible upon copying a new in node red it copies a second subflow but this is not needed.

Question: I only get the notifications on android when the screen is turned on, can this be changed somewhere?

1 reply

sanderlv May 17, 2021

note 2 self for question:

add this here:
priority: "high",

greghesp · 2021-06-07T11:20:25Z

greghesp
Jun 7, 2021

Does anyone else get the following error?
"Call-Service attempted without connection to server."

4 replies

zachowj Jun 7, 2021
Maintainer Author

I would guess you're triggering the flow before NR has had a chance to connect to NR. This normally happens when you start a flow with a inject node or some other node that triggers right after it has been loaded by NR.

In a recent release, I added a queue system to the call-service node to help with these use cases.

greghesp Jun 7, 2021

Ah that makes perfect sense actually! Will keep playing, thanks :)

greghesp Jun 7, 2021

@zachowj Do you know where the throttle node is coming from?

I don't seem to have this one installed and cant find it anywhere

zachowj Jun 7, 2021
Maintainer Author

If I wrote that today I would just use a delay node set to rate limit. I would just swap that node out.

zupancicmarko · 2021-07-05T06:17:13Z

zupancicmarko
Jul 5, 2021

Hi @zachowj , quick quesiton...

I get this error when trying to call the "mobile_app_jason" service.
"Call-service API error. Error Message: Service not found."

Any ideas?

5 replies

zachowj Jul 5, 2021
Maintainer Author

You have an incorrect service defined in the config

zupancicmarko Jul 5, 2021

Awesome! Thanks for the quick reply. Changed it to "notify" and now its working! 🙌
Thanks a million!

jwilleke Sep 13, 2021

I give up. What is supposed to be in there for mobile_app_jason?
Where does "mobile_app_jason" this come from?

zachowj Sep 13, 2021
Maintainer Author

It's normally the name of your phone.

You can find it by dropping a call-service node down then entering notify as the domain and the autocomplete should show up with available options. You can also do this from the HA dev tools.

jwilleke Sep 13, 2021

Thanks!

pixel217 · 2021-09-15T14:46:32Z

pixel217
Sep 15, 2021

hello,
I have issues trying to get this to work

I am using nodered version 10 and it requested to update the nodes of the subflow....

I am focussing on one error at a time, and for the first one : I tried to put the correct Notify Service (mobile_app_xxx) that works in another service call for non actionable notifications :/

3 replies

zachowj Sep 15, 2021
Maintainer Author

Open up the subflow and then open up each HA node so it sets the server then deploy.

pixel217 Sep 15, 2021

going to try this, will report if successful

pixel217 Sep 15, 2021

wonderfull!!! that worked!

this subflow is bliss!

thanks for that great developement!

BigManDave · 2021-09-27T11:54:50Z

BigManDave
Sep 27, 2021

Greetings,
I've just found this subflow today and I love it, great work!

I'm seeing an issue where as soon as I enter a URI for an action it no longer outputs from the node. i.e It puts a stop to my flow.
Do you have any advice please?

P.S. Sorry for any language errors, I'm very new to Node-Red :)

4 replies

zachowj Sep 27, 2021
Maintainer Author

Are you getting any errors in the debug panel?

BigManDave Sep 27, 2021

Thanks for responding so quickly.
Nope, I'm not seeing anything in the debug panel. I've even tried adding a debug node to the output with the URI and still nothing.

zachowj Sep 27, 2021
Maintainer Author

I need to update the cookbook but give my latest version a try and see if it works for you.

https://gist.github.com/zachowj/a594c63e2d788d89d17fc93d01905042

BigManDave Sep 28, 2021

Thanks for sending that over. Unfortunately it's still performing the same.

dbs179 · 2021-10-14T19:01:11Z

dbs179
Oct 14, 2021

Hello,

Great work, this subflow and your examples have helped me tremendously. Someone asked it above, but I didn't see a response. Is there anyway to include an attachment within this? I'm using it for a doorbell notification and have the flow taking a snapshot at the doorbell cam, but can't figure out how to include it.

Thanks for sharing this with the community!!

6 replies

dbs179 Oct 14, 2021

Excellent. I'll have a look at this new version and samples!!!

dbs179 Oct 15, 2021

Thanks again. I was able to use this to do what I was trying to do. I greatly appreciate it!

sanderlv Oct 15, 2021

May I ask how to use the "clear_notification" in a flow instead of a manual trigger?

zachowj Oct 15, 2021
Maintainer Author

change node

sorted01 Oct 19, 2021

Hi @zachowj
First of all, thank you for that awesome subflow. It works like a charm as long as my phone is not "sleeping". If that is the case if have to wait until I unlock it. There is a whole thread about this issue on samsung phones like mine:
https://community.home-assistant.io/t/notification-delay-samsung-s10/222615/34

The solution seems following:
I came here to share my experience with my S10+. I managed to solve my delay by using “priority” instead of “importance” as well. I’m glad there’s a topic here and that you’re helping others already! I wish I had found this thread before wasting many hours on it.

But as I am quite new to home assistant and node-red I don't know where and how to change it in your subflow :)

Any help would be highly welcome!

Thank you!

EDIT

Seems to be answered above. I'll give it a try! :) - priority: "high"

sanderlv · 2021-10-15T19:10:18Z

sanderlv
Oct 15, 2021

Another question about this flow for the trigger "Override with image and action". What is this meant for? To send a picture along? I can't get this going...

What should I do?

{
    "title": "override title",
    "message": "override message",
    "data": {
        "image": "https://raw.githubusercontent.com/home-assistant/assets/master/logo/logo.png",
        "actions": [
            null,
            {
                "title": "Home Assistant",
                "uri": "https://home-assistant.io"
            }
        ]
    }
}

1 reply

zachowj Oct 25, 2021
Maintainer Author

It's meant as an example of how you can override any settings of the notification from a message property. For this to work correctly you need to be using the export from the last gist or after I have updated the example to the gist version.

https://gist.github.com/zachowj/a594c63e2d788d89d17fc93d01905042

ffurious01 · 2021-11-09T06:18:16Z

ffurious01
Nov 9, 2021

Hi Zach,

I am getting following error: "Call-Service attempted without connection to server." when I try testing the demo flow by just replacing the "Notify Service" env variable with the reference of my phone.

What am I doing wrong? Please help.

2 replies

zachowj Nov 14, 2021
Maintainer Author

Need to wait for NR to connect to HA.

ffurious01 Nov 15, 2021

Thanks Zach. It worked! It looks like a HA restart cleared up things.

lewtopia · 2021-11-15T16:34:38Z

lewtopia
Nov 15, 2021

Fantastic recipe!

My question, which is sort of answered in part above:

How to adjust the properties of the subflow and service call for HA instances with more than one mobile device?

ie: send the notification to one of the mobiles registered with HA.

The only solution I could envision is not using a subflow, or making multiple copies of the subflow for each mobile device. (But that would then defeat the purpose of the subflow...)

Any suggestion on how to pass the notify service to the subflow to allow for multiple mobile_app_{{device_id}} ?

3 replies

ffurious01 Nov 15, 2021

Lewtopia,

Regarding how to call service on more than one device, I was able to add multiple devices to the "Notify Service" property (comma separated) and all the devices get notifications.

lewtopia Nov 15, 2021

That is a possibility.

My intent is to send an actionable notification when device connects to home wifi with an action to unlock the door.

So, it doesn't make the best sense to send the notification to all phones, since not all would be connecting to wifi at the same time, or rather, not all phones would be arriving home at the same time.

Nor would I want family members unlocking doors when not at home (that would be checked in/before the service call).

zachowj Nov 15, 2021
Maintainer Author

You could change this line in the create service call function

const services = env.get('service');

to

const services = msg.service || env.get('service');

If the msg object with the property service set it will override the value set in the subflow config.

xvlw · 2021-12-23T14:44:35Z

xvlw
Dec 23, 2021

This looks fantastic. I am also getting this error msg : string[38] "Call-service error. Service not found." when trying to deploy the Demo Flow that I can't solve.

I believe it may have to do with this node

What part did I not do right haha. When I first opened this node up it was blank, just had notify in the Domain field, I filled in the Service (not sure if i needed to). Is it because I don't have an entity or should I be filling this node out at all.

5 replies

zachowj Dec 23, 2021
Maintainer Author

remove notify. from the service field just use the service part and not the domain

zachowj Dec 23, 2021
Maintainer Author

xvlw Dec 23, 2021

Yessss! Thank you!!!

xvlw Dec 23, 2021

Kinda curious, I wonder if there is a way to use the fingerprint authentication from Android to confirm if the button action should be initiated.

Enter Zone > Push Notification > Action Button > Fingerprint Auth > Action Performed.

Puts an extra security layer on the action for unlocking doors and that kind of stuff

vaderag Aug 26, 2022

Wondering if this is the same thing I'm seeing here: #311 (comment)

I'm not clear how to get to that Environment Variables option - i see this on that node:

theoracle09 · 2021-12-29T18:32:40Z

theoracle09
Dec 29, 2021

Hi zachowj and thank you so much for putting the time and support into this subflow. I didn't even know NR was capable of these things, which is gonna get me really digging into it.

I've read this thread 3 times now as well as picking through the code but can't find a solution: can the notification be removed from android's status bar once the action has been pressed? I see the sticky tick box, but ticked or unticked the notification stays. Once the action is over (I'm using it to open the HA app to a certain lovelace dash) I do see in NR the subflow text at the bottom says "cleared" with date and time. But I'd like it to clear the notification on press of the action button. Am I missing something?

Edit to add: with the sticky box unticked if I tap the notification itself it opens HA and the notification gets removed. But if I click Action 1 (which is a uri: "/lovelace/mail") it launched the correct dashboard but keeps the notification in the status bar.

One more edit: I just looked over your Expiration Date Monitor in your cookbook and realize you're the one that helped me with that almost two years ago. Dang! Thanks for all that you do!

0 replies

platini76 · 2023-05-31T01:18:19Z

platini76
May 31, 2023

hello, I have a problem:
with this subflow:
[{"id":"ef0c0401ea06e563","type":"function","z":"2be39f25880a1f22","name":"create service call","func":"const actions = [];\n[1,2,3].forEach(i => {\n const name = action${i}\n const id = flow.get(${name}Id);\n const title = env.get(${name}Title);\n const uri = env.get(${name}Uri);\n const action = !!uri.length ? 'URI' : title ? flow.get(${name}Id) : undefined;\n \n actions.push({\n action,\n title,\n uri\n });\n});\n\nmsg._originalPayload = msg.payload;\nflow.set('latestMessage', msg);\n\nconst services = env.get('service');\nif(!services) {\n node.status({\n text: 'no services defined',\n shape: 'ring',\n fill: 'red'\n });\n return; \n}\n\nservices.trim().split(/,\\s*/).forEach(service => {\n if(!service) return;\n \n msg.payload = {\n service,\n data: {\n title: env.get('title'),\n message: env.get('message'),\n data: {\n tag: flow.get('notificationTag'),\n actions,\n color: env.get(\"color\"),\n group: env.get(\"group\"),\n sticky: env.get(\"sticky\"),\n timeout: env.get(\"timeout\"),\n icon: env.get(\"icon\")\n }\n }\n };\n node.send(msg);\n});\n\nnode.done();","outputs":1,"noerr":0,"initialize":"const randomId = () => Math.random().toString(36).replace(/[^a-z]+/g, '').substr(0, 5);\n\n[1,2,3].forEach(i => {\n flow.set(action${i}Id, action${i}${randomId()});\n})\n\n\nflow.set('notificationTag', ${env.get('title')}${randomId()});","finalize":"","libs":[],"x":298,"y":80,"wires":[["44ad44d566d8decc"]]},{"id":"68aed778d8d636cd","type":"switch","z":"2be39f25880a1f22","name":"which action?","property":"eventData.event.action","propertyType":"msg","rules":[{"t":"eq","v":"action1Id","vt":"flow"},{"t":"eq","v":"action2Id","vt":"flow"},{"t":"eq","v":"action3Id","vt":"flow"}],"checkall":"true","repair":false,"outputs":3,"x":1024,"y":176,"wires":[[],[],[]]},{"id":"c8dc59186bb49025","type":"status","z":"2be39f25880a1f22","name":"","scope":["ef0c0401ea06e563","ef4eab8fb9f3384f","4647218aa50bcba7","44ad44d566d8decc"],"x":124,"y":272,"wires":[[]]},{"id":"ef4eab8fb9f3384f","type":"function","z":"2be39f25880a1f22","name":"build message","func":"const latestMessage = flow.get('latestMessage');\nconst event = msg.payload.event;\n\nlatestMessage.eventData = msg.payload;\nlatestMessage.payload = latestMessage._originalPayload;\ndelete latestMessage._originalPayload;\n\nif(env.get('userInfo')) {\n const userData = msg.userData.find(u => u.id === msg.payload.context.user_id);\n latestMessage.userData = userData;\n}\n\nif(msg.event_type === 'mobile_app_notification_cleared') {\n node.status({\n text: cleared at: ${getPrettyDate()},\n shape: 'dot',\n fill: 'blue'\n });\n \n return [null, latestMessage];\n}\n\nconst index = [1,2,3].find(i => event[action_${i}_key] === event.action);\nnode.status({\n text: ${event[action_${index}_title]} at: ${getPrettyDate()},\n shape: 'dot',\n fill: 'green'\n});\n\nreturn latestMessage;\n\n\nfunction getPrettyDate() {\n return new Date().toLocaleDateString('en-US', {\n month: 'short',\n day: 'numeric',\n hour12: false,\n hour: 'numeric',\n minute: 'numeric',\n });\n}","outputs":2,"noerr":0,"initialize":"","finalize":"","x":832,"y":176,"wires":[["68aed778d8d636cd"],[]]},{"id":"6c158951eb7503ea","type":"switch","z":"2be39f25880a1f22","name":"belongs here?","property":"payload.event.tag","propertyType":"msg","rules":[{"t":"eq","v":"notificationTag","vt":"flow"}],"checkall":"true","repair":false,"outputs":1,"x":432,"y":176,"wires":[["59e893d2701dfedf"]]},{"id":"ed6aad130d5057ad","type":"ha-api","z":"2be39f25880a1f22","name":"get user info","server":"e8e7fd0.247eb","version":1,"debugenabled":false,"protocol":"websocket","method":"get","path":"","data":"{\"type\": \"config/auth/list\"}","dataType":"json","responseType":"json","outputProperties":[{"property":"userData","propertyType":"msg","value":"","valueType":"results"}],"x":822,"y":128,"wires":[["ef4eab8fb9f3384f"]]},{"id":"5a2faf0d7685928e","type":"server-events","z":"2be39f25880a1f22","name":"mobile_app_notification_cleared","server":"e8e7fd0.247eb","version":2,"eventType":"mobile_app_notification_cleared","exposeToHomeAssistant":false,"eventData":"","haConfig":[{"property":"name","value":""},{"property":"icon","value":""}],"waitForRunning":false,"outputProperties":[{"property":"payload","propertyType":"msg","value":"","valueType":"eventData"},{"property":"topic","propertyType":"msg","value":"$outputData(\"eventData\").event_type","valueType":"jsonata"},{"property":"event_type","propertyType":"msg","value":"$outputData(\"eventData\").event_type","valueType":"jsonata"}],"x":194,"y":224,"wires":[["6c158951eb7503ea"]]},{"id":"59e893d2701dfedf","type":"switch","z":"2be39f25880a1f22","name":"fetch user info?","property":"userInfo","propertyType":"env","rules":[{"t":"true"},{"t":"else"}],"checkall":"true","repair":false,"outputs":2,"x":624,"y":176,"wires":[["ed6aad130d5057ad"],["ef4eab8fb9f3384f"]]},{"id":"c189f1c114241c9b","type":"switch","z":"2be39f25880a1f22","name":"","property":"clear_notification","propertyType":"msg","rules":[{"t":"null"},{"t":"nnull"}],"checkall":"true","repair":false,"outputs":2,"x":143,"y":80,"wires":[["ef0c0401ea06e563"],["4647218aa50bcba7"]],"l":false},{"id":"4647218aa50bcba7","type":"function","z":"2be39f25880a1f22","name":"create clear notification","func":"const services = env.get('service');\nif(!services) {\n node.status({\n text: 'no services defined',\n shape: 'ring',\n fill: 'red'\n });\n return; \n}\n\nservices.trim().split(/,\\s*/).forEach(service => {\n if(!service) return;\n \n msg.payload = {\n service,\n data: {\n message: \"clear_notification\",\n data: {\n tag: flow.get('notificationTag'),\n }\n }\n };\n node.send(msg);\n});\n\nnode.done();","outputs":1,"noerr":0,"initialize":"","finalize":"","x":318,"y":128,"wires":[["44ad44d566d8decc"]]},{"id":"38ef7a370d7390ad","type":"server-events","z":"2be39f25880a1f22","name":"mobile_app_notification_action","server":"e8e7fd0.247eb","version":2,"eventType":"mobile_app_notification_action","exposeToHomeAssistant":false,"eventData":"","haConfig":[{"property":"name","value":""},{"property":"icon","value":""}],"waitForRunning":false,"outputProperties":[{"property":"payload","propertyType":"msg","value":"","valueType":"eventData"},{"property":"topic","propertyType":"msg","value":"$outputData(\"eventData\").event_type","valueType":"jsonata"},{"property":"event_type","propertyType":"msg","value":"$outputData(\"eventData\").event_type","valueType":"jsonata"}],"x":194,"y":176,"wires":[["6c158951eb7503ea"]]},{"id":"44ad44d566d8decc","type":"api-call-service","z":"2be39f25880a1f22","name":"","server":"e8e7fd0.247eb","version":5,"debugenabled":false,"domain":"notify","service":"","areaId":[],"deviceId":[],"entityId":[],"data":"","dataType":"json","mergeContext":"callServiceData","mustacheAltTags":false,"outputProperties":[],"queue":"none","output_location":"","output_location_type":"none","x":550,"y":80,"wires":[[]]},{"id":"e8e7fd0.247eb","type":"server","name":"Home Assistant","addon":true,"rejectUnauthorizedCerts":true,"ha_boolean":"","connectionDelay":false,"cacheJson":false,"heartbeat":false,"heartbeatInterval":"","statusSeparator":"","enableGlobalContextStore":false}]

and this flow:

notify arrive, but no choose to dismiss or ignore... what is my mistake?

0 replies

platini76 · 2023-05-31T02:00:15Z

platini76
May 31, 2023

ok now I have choose to do.. but once clicked.. nothing happens

0 replies

jj-uk · 2023-06-17T10:11:47Z

jj-uk
Jun 17, 2023

@zachowj This Node works very well, I've been using it for a long time now.

Is there a reason this is a sub flow instead of a Node in the official release?

0 replies

sprynm · 2023-07-19T23:54:58Z

sprynm
Jul 19, 2023

Why is my actionable.service override failing?

Case One: Notify Service field is left blank in the subflow config node
Result: "no services defined"

Case Two: a default phone is entered to the Notify Service field of the subflow config node
Result: "Call-service error. extra keys not allowed @ data['service']"

If I move mobile_app_lance_s10_phone from the inject node to the subflow config node, it all works great.

Is it required to "hard code" a phone that can't be changed dynamically later?

1 reply

zachowj Jul 20, 2023
Maintainer Author

Doesn't look like I wrote it to accept services dynamically. You can edit the "create service call" function node in the subflow and change line 4.

const services = env.get('service');

to

const services = msg.service ?? env.get('service');

That would allow you to dynamically insert services that would override the ones set in the config.

You then would have to pass services via msg.service.

salleq · 2023-08-22T19:49:55Z

salleq
Aug 22, 2023

For some reason the flow/subflow isn't working on an iOS device right now. I tested actionable notifications directly from HA and they worked. The issue is that no action is run, it seems that when I press any action on iOS device, there's no tag and all the other stuff coming from the app. Here's a debug log from "mobile_app_notification_action" node inside the subflow, first from an Android device and then from an iOS device, they're different..

{
  event_type: 'mobile_app_notification_action',
  entity_id: undefined,
  event: {
    tag: 'testing actionable notification_tsdmz',
    title: 'testing actionable notification',
    webhook_id: '02fc49aceeb44c6ccdfd08ffa96e07ad236ca269510ff5e1bb739c48b6d7e5cc',
    action_1_title: 'action one',
    action_1_key: 'action1_jcfid',
    server_id: '1',
    action: 'action1_jcfid',
    device_id: 'REDACTED'
  },
  origin: 'REMOTE',
  time_fired: '2023-08-22T19:37:49.884126+00:00',
  context: {
    id: '01H8FC1PHWEV4WN0W9GKD542PE',
    parent_id: null,
    user_id: 'REDACTED'
  }

  
  {
  event_type: 'mobile_app_notification_action',
  entity_id: undefined,
  event: { action: 'action1_tkarq' },
  origin: 'REMOTE',
  time_fired: '2023-08-22T19:37:20.731473+00:00',
  context: {
    id: '01H8FC0T2VTPQ2KM6M43HDG34V',
    parent_id: null,
    user_id: 'REDACTED'
  }
}

EDIT: Right...it's in the title "Subflow for Android" :D
So it's not meant to work on iOS, sorry...

2 replies

zachowj Aug 24, 2023
Maintainer Author

There should be a link somewhere in the discussion for an iOS version.

salleq Aug 25, 2023

Yeah I did found it after I figured out to search for iOS version specifically :D but before that I didn't read the whole thread obviously. Maybe the Android/iOS could be crosslinked to make it easier to find (?), but I admit I was too dumb to immediately recognize the title...

teek541 · 2023-12-07T08:21:17Z

teek541
Dec 7, 2023

Thank you for writing this!

I modified mine a bit to take messages to alter pretty much every aspect of the notification. Let me know what you think. I just found this discussion and I think maybe I duplicated some work with the msg.actionable.[field] option. Mine also takes a msg.attachment input and parses it to be either an image or video.

I'm just getting into HA and Node Red still, as well as learning how to navigate GitHub. Also new to JS, I'm mostly a SQL guy, but I took a coding class back in college, they only covered VB though. I learned a lot parsing through your code.

Edit: I just noticed that it doesn't output the actions anymore. Going back to troubleshooting.

//Store original message
msg._originalPayload = msg.payload;
flow.set('latestMessage', msg);

//Get Services to send notification to, if no services defined, errors out.
const services = msg.services || env.get('service');
if (!services) {
    node.status({
        text: 'no services defined',
        shape: 'ring',
        fill: 'red'
    });
    return;
}

//Constructs actions array
const actions = [1, 2, 3].reduce((acc, i) => {
    const name = `action${i}`;
    const id = flow.get(`${name}Id`);
    const actionFromEnv = (msg?.[`action${i}action`] || getActionProperty(i, "action")) ?? env.get(`${name}Action`);
    const title = (msg?.[`action${i}title`] || getActionProperty(i, "title")) ?? env.get(`${name}Title`);
    const uri = (msg?.[`action${i}uri`] || getActionProperty(i, "uri")) ?? env.get(`${name}Uri`);

    const action = actionFromEnv.length ? actionFromEnv : (uri.length ? 'URI' : title ? id : undefined);

    // Skip the accumulator for this iteration if no action is given
    if (action === undefined) {
        return acc;
    }

    acc.push({ action, title, uri });

    return acc;
}, []);

//Compile notification tag
const tagFromEnv = msg.tag || env.get('tag');
const tagDefault = flow.get('notificationTag');
const tag = tagFromEnv?.length ? tagFromEnv : tagDefault;

// Compile attachment data
let attachment = msg.attachment || env.get('attachment');
const imageExtensions = ['.jpeg', '.jpg', '.gif', '.png'];
const videoExtensions = ['.mpeg', '.mpg', '.mp4', '.avi'];


let imageAttachment;
let videoAttachment;

// Check if attachment contains an image file extension
if (attachment && imageExtensions.some(ext => attachment.toLowerCase().includes(ext))) {
    imageAttachment = `${attachment}`
}

// Check if attachment contains a video file extension
if (attachment && videoExtensions.some(ext => attachment.toLowerCase().includes(ext))) {
    videoAttachment = `${attachment}`
}

// Create Notification Attachment
//const notificationAttachment = videoAttachment || imageAttachment;





const data = mergeDeep({
    title: msg.title || env.get("title"),
        message: msg.message || env.get("message"),
            data: {
            tag, 
			video: videoAttachment,
			image: imageAttachment,
            color: msg.color || env.get("color"),
            group: msg.group || env.get("group"),
            sticky: msg.sticky || env.get("sticky"),
            timeout: msg.timeout || env.get("timeout"),
            icon: msg.icon || env.get("icon")
        },
    },
    msg.actionable,
    { data: { actions } },
);

//Check to see if the tag has changed
if (tag !== data?.data?.tag) {
    flow.set('notificationTag', data?.data?.tag);
}

services.trim().split(/,\s*/).forEach(service => {
    if (!service) return;

    msg.payload = {
        service,
        data,
    };
    node.send(msg);
});

node.done();

function getActionProperty(index, prop) {
    const i = index - 1;

    return msg?.actionable?.data?.actions?.[i]?.[prop];
}

/**
 * Simple object check.
 * @param item
 * @returns {boolean}
 */
function isObject(item) {
    return (item && typeof item === 'object' && !Array.isArray(item));
}

/**
 * Deep merge two objects.
 * @param target
 * @param sources
 */
function mergeDeep(target, ...sources) {
    if (!sources.length) return target;
    const source = sources.shift();

    if (isObject(target) && isObject(source)) {
        for (const key in source) {
            if (isObject(source[key])) {
                if (!target[key]) Object.assign(target, { [key]: {} });
                mergeDeep(target[key], source[key]);
            } else {
                Object.assign(target, { [key]: source[key] });
            }
        }
    }

    return mergeDeep(target, ...sources);
}

I also had to edit the clear notification to allow for static tags/services to be set.

const services = msg.services || env.get('service');
const tagFromEnv = msg.tag || env.get('tag');
const tagDefault = flow.get('notificationTag');
const tag = tagFromEnv?.length ? tagFromEnv : tagDefault;
if(!services) {
    node.status({
        text: 'no services defined',
        shape: 'ring',
        fill: 'red'
    });
    return;    
}

services.trim().split(/,\s*/).forEach(service => {
    if(!service) return;
    
    msg.payload = {
        service,
        data: {
            message: "clear_notification",
            data: {
                tag: tag,
            }
        }
    };
    node.send(msg);
});

node.status({text: "cleared"});
node.done();

0 replies

ACiDGRiM · 2023-12-11T08:36:36Z

ACiDGRiM
Dec 11, 2023

I moved one of my home assistant os installs to a simple docker compose of home assistant and nodded, now I'm getting this error suddenly

InputError: Invalid merge context: callServiceData

Which is occurring where the function node hands-off the payload with notify options to the notify service node.

I can't find an explination. Has anyone run into this?

3 replies

salleq Dec 31, 2023

This started happening for me as well. But I've been on dockerised HA/Node Red for a long time, so it must've been some of the latest updates for the HA websocket.

EDIT: I realised I'm once again in the Android subflow thread (I'm using iOS right now) but thought worth mentioning.

salleq Jan 2, 2024

Not sure if this is a correct way to fix it, but I noticed that "Send notifications" Service Call node had "callServiceData" in the merge context field. I removed that and it started working again🤷

zachowj Jan 2, 2024
Maintainer Author

In the next release 0.62.3 if the mergeContext doesn't exist it won't through an error.

antb33 · 2024-01-01T05:27:16Z

antb33
Jan 1, 2024

How do I use the action REPLY feature? I would like to be able to add a comment when I click the action on Android, then use the inputed data in the subsequent flow.

From the HA documentation about actions: When set to REPLY, you will be prompted for text to send with the event.. I can't figure out how to configure this.

This subflow fantastic, many thanks!

2 replies

zachowj Jan 2, 2024
Maintainer Author

REPLY currently won't work with this subflow

antb33 Jan 2, 2024

OK thanks

dovy6 · 2024-01-14T04:32:50Z

dovy6
Jan 14, 2024

Thanks for this, it's super helpful to me and many others.
Question for you. Is there a way to have multiple channels, for different notifications? For example, I want a different notification on my phone when someone rings my doorbell (my phones play doorbell.mp3) than when the garage door is open

const data = mergeDeep({
        title: env.get('title'),
        message: env.get('message'),
        data: {
            tag,
            color: env.get("color"),
            group: env.get("group"),
            sticky: env.get("sticky"),
            timeout: env.get("timeout"),
            icon: env.get("icon"),
            ttl: 0,
            priority: "high",
            channel: "doorbell",

This appears to be set "node-red-wide" and not just for a specific call to "actionable notifications." My goal would be able to have perhaps more than one copy of the function so I could set more than one channel. Is this possible?

Thanks again @zachowj

Dovy

1 reply

zachowj Jan 14, 2024
Maintainer Author

A temporary solution would be to have a change node before the subflow that sets the channel property.

{
 "data": {
    "channel": "doorbell"
  }
}

or if you're feeling adventurous you can add a new field to the subflow and then add it where you have channel defined above.

channel: env.get("channel"),`

dovy6 · 2024-01-14T06:09:11Z

dovy6
Jan 14, 2024

Thanks so much, adding a channel field and env.get("channel"), appears to have worked super well and was super easy to implement!

If I may bother you for another question, I'm trying to warn myself that the garage door has been open for x minutes. For some reason, the notification that comes in only says "The garage door has been open for minutes," not parsing the {{minutes}} as a variable. What do I need to change?

(yes I know the 30 minute timer is currently only 1 minute long, did that for testing purposes)
Thanks so much for your quick response

0 replies

Takore2002 · 2024-02-13T03:25:20Z

Takore2002
Feb 13, 2024

This is probably one of my most used nodes in Home Assistant so thank you!

Do you have any ideas on how I can generate multiple messages from a single trigger event without the messages overwriting each-other?

I've modified it fairly heavily so I can use nodes earlier in the flow to dynamically change different fields like the services/title/message/etc. I recently ran into an issue where I'm trying to trigger multiple messages off of one trigger event.

0 replies

RickTorresJr · 2024-03-02T08:03:46Z

RickTorresJr
Mar 2, 2024

Is it possible to get an example of setting the overrides via a Function node? I'm having trouble mapping the actions portion. Thanks.

msg.actionable = {
  title: "override this title",
  message: "override this message",
  
  data: {
    color: "red",
    sticky: "true?",
    "actions": [
        1,
        {
            "title": "title 1"
        }
    ]
  }
};
return msg;

2 replies

zachowj Mar 3, 2024
Maintainer Author

As it is currently written you are unable to override actions.

RickTorresJr Mar 3, 2024

Thank you for the reply. I apologize but I guess I have a misunderstanding of overrides in Node-Red or I'm missing something.

The Cookbook says Any setting can be set or overwritten using msg.actionable to pass a notification object into the node. I'm just trying to pass in the values via msg.actionable depending on the situation. The array syntax is the one giving me problems. It works but in my example above title 1 is intended to the the first action but is placed as the second. I'm looking for an example of the correct syntax for 3 actions.

#311 (reply in thread)

jsbrich · 2024-03-04T23:00:30Z

jsbrich
Mar 4, 2024

Noticed today that I haven't been getting any notifications on things that go through this subflow. I don't get a lot of them, so I'm not exactly sure when it stopped or what all has been updated lately. When I open the subflow template, under the "create service call" function, it is showing some errors. Are these normal?
Lines 17 and 18 have this

Line 43:

Line 44:

Line 62:

5 replies

rossco555 Mar 4, 2024

Yeah, Node Red doesn't seem to think it supports those operators... but it does from my experience and I see those to and don't have issues. I don't think these are the source of your problem.

jsbrich Mar 5, 2024

So I added debugs to the subflow

When a send is triggered, Debug 4 shows msg, it doesn't contain msg.clear_notifications as expected. Debug 5 is triggered, same message as 4. But that's it. Debug 2 doesn't show anything like I would expect. But no error that I can find.

rossco555 Mar 5, 2024

Why don't you expect debug 2 to show anything? Did you set the debugs up to show the complete message, not just "message"?

jsbrich Apr 12, 2024

I switched to the whole message. When a message is triggered, I see some values in the payload object of data I populate in the parent flow in Debug 4 and 5, but Debug 2 is never triggered. Which, to me indicates something is going wrong in the "create service call" box, but I don't see any error messages or anything in the debug window

jsbrich Apr 12, 2024

I figured it out, updating from Node.js 14 to 20 resolved the issue. I'm not sure why it just suddenly stopped working before, but it seems to be good now.

dominusarbitrationis · 2024-04-28T01:52:33Z

dominusarbitrationis
Apr 28, 2024

How would I change the title on the fly for a notification? I have tried

msg.actionable = { title: "override this title", message: "override this message", }; return msg;

In a function node immediately prior to the notification node, but no luck.

3 replies

zachowj Apr 28, 2024
Maintainer Author

What you have works for me. Are you sure you're running the current subflow linked at the top?

dominusarbitrationis Apr 28, 2024

Just remade the subflow with a copy of what's above, and that did fix it. Odd. Not sure where I got the other subflow code from, then.

dominusarbitrationis Apr 28, 2024

What you have works for me. Are you sure you're running the current subflow linked at the top?

Is there a way to get a separate notification per channel? I'm trying to have just one flow that detects my lights, and if they are on for more than 15 minutes, send a notification to let me turn them off. But, if I turn on multiple lights, the latest notification overrides all others.

vaderag · 2024-06-07T09:14:34Z

vaderag
Jun 7, 2024

Just noticed this had stopped working for me - I use it for a flow that triggers when I go on holiday and when I went on holiday I got no notification

I assume this is due to the way that notifications changed in HA recently, but I'm not quite sure - I don't see a new version on the main page tho so can anyone help me to understand how to fix this?!
From what I can tell it's the notification portion that is failing

2 replies

zachowj Jun 7, 2024
Maintainer Author

It is still working on the latest release of HA, 2024.6.0

vaderag Jun 7, 2024

It is still working on the latest release of HA, 2024.6.0

Hmm okay, strange. Bit more digging and it seems related to my notification group not working.

Actionable Notifications Subflow for Android #311

zachowj Dec 19, 2020 Maintainer

Replies: 42 comments · 96 replies

zachowj Apr 17, 2021 Maintainer Author

zachowj Jan 27, 2022 Maintainer Author

zachowj Sep 14, 2022 Maintainer Author

zachowj Jun 7, 2021 Maintainer Author

zachowj Jun 7, 2021 Maintainer Author

zachowj Jul 5, 2021 Maintainer Author

zachowj Sep 13, 2021 Maintainer Author

zachowj Sep 15, 2021 Maintainer Author

zachowj Sep 27, 2021 Maintainer Author

zachowj Sep 27, 2021 Maintainer Author

zachowj Oct 15, 2021 Maintainer Author

zachowj Oct 25, 2021 Maintainer Author

zachowj Nov 14, 2021 Maintainer Author

zachowj Nov 15, 2021 Maintainer Author

zachowj Dec 23, 2021 Maintainer Author

zachowj Dec 23, 2021 Maintainer Author

zachowj
Dec 19, 2020
Maintainer

Replies: 42 comments 96 replies

zachowj Apr 17, 2021
Maintainer Author

zachowj Jan 27, 2022
Maintainer Author

zachowj Sep 14, 2022
Maintainer Author

zachowj Jun 7, 2021
Maintainer Author

zachowj Jun 7, 2021
Maintainer Author

zachowj Jul 5, 2021
Maintainer Author

zachowj Sep 13, 2021
Maintainer Author

zachowj Sep 15, 2021
Maintainer Author

zachowj Sep 27, 2021
Maintainer Author

zachowj Sep 27, 2021
Maintainer Author

zachowj Oct 15, 2021
Maintainer Author

zachowj Oct 25, 2021
Maintainer Author

zachowj Nov 14, 2021
Maintainer Author

zachowj Nov 15, 2021
Maintainer Author

zachowj Dec 23, 2021
Maintainer Author

zachowj Dec 23, 2021
Maintainer Author