home-assistant.io/source/_integrations/notify_events.markdown

title	description	ha_release	ha_category	ha_domain	ha_codeowners	ha_iot_class	ha_platforms	ha_integration_type
Notify.Events	Instructions on how to integrate Notify.Events service with your Home Assistant notifications.	0.112	Notifications	notify_events	@matrozov @papajojo	Cloud Push	notify	integration

Description

The Notify.Events service is a platform for the notify component.

This platform allows you to quickly configure the distribution of messages between different recipients, no matter how they are used to receiving notifications:

• Telegram
• Viber
• Slack
• Rocket.Chat
• Discord
• Jabber / XMPP
• Webpush
• SMS
• VoiceCall

You can find a full supported messenger list here.

Setting up

To start getting notifications, you need to follow those simple steps:

1. Sign up to Notify.Events and create a Channel
2. Add Home Assistant source to this channel and get your token
3. Add the Notify.Events integration to your installation by adding the following to your configuration.yaml file:

notify_events:
  token: YOUR_TOKEN

{% configuration %} token: description: Your channel source token. required: true type: string {% endconfiguration %}

Now you can use notify_events integration as a platform for your notify service, add the following to your configuration.yaml file:

# Example configuration.yaml entry

notify:
  - name: NOTIFIER_NAME (e.g. "events")
    platform: notify_events

{% configuration %} name: description: "The optional parameter name allows multiple notifiers to be created. The notifier will bind to the service notify.NOTIFIER_NAME." required: false type: string default: notify {% endconfiguration %}

That's it!

Now you can use the notify.events service inside your Home Assistant to:

• Send any notifications or alerts
• Distribute events by level and priority
• Attach files and images (local or remote)
• .. and just keep using your favorite messenger to receive them!

Example service call

- service: notify.events
  data:
    message: "Backyard motion detected!"
    data:
      level: "warning"
      priority: "high"
      images:
        - name: "local_photo.jpg"
          path: "/tmp/backyard_cam/motion.jpg"
        - name: "remote_photo.jpg"
          url: "https://i.ibb.co/Jt1845X/motion.jpg"

Message optional parameters

The following attributes can be placed inside data for extended functionality.

Attribute	Description
title	Message title.
level	For recipients who have differences in the display of messages at different levels, this level will be applied. Available values: verbose, info, notice, warning, error, success.
priority	For recipients which supports priority, the message will be highlighted accordingly. Available values: lowest, low, normal, high, highest.
images	Array of images to attach (see item properties below).
files	Array of files to attach (see item properties below).
token	Notify.Events channel token (in case you want to override the channel to get this message to).

Every item of images and files has the following properties:

Property	Required	Description
path or url or content	True	File source.
name	False	Result file name
mime_type	False	File MIME-type

To use notifications effectively, please see the getting started with automation page.