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

title	description	ha_category	ha_iot_class	ha_release	ha_domain	ha_platforms	ha_integration_type	related	ha_quality_scale
MessageBird	Instructions on how to add MessageBird notifications to Home Assistant.	Notifications	Cloud Push	0.16	message_bird	notify	integration	docs title /docs/configuration/ Configuration file	legacy

The MessageBird notification {% term integration %} sends notifications as SMS messages using MessageBird to your mobile phone.

Setup

Go to MessageBird to retrieve your API key.

Configuration

To enable MessageBird notifications in your installation, add the following to your {% term "configuration.yaml" %} file. {% include integrations/restart_ha_after_config_inclusion.md %}

# Example configuration.yaml entry
notify:
  - name: NOTIFIER_NAME
    platform: message_bird
    api_key: YOUR_API_KEY

{% configuration %} api_key: description: Your MessageBird API key. required: true type: string name: description: Setting the optional parameter name allows multiple notifiers to be created. The notifier will bind to the notify.NOTIFIER_NAME action. required: false default: notify type: string sender: description: Setting the optional parameter sender. This will be the sender of the SMS. It may be either a telephone number (e.g., +4915112345678) or a text with a maximum length of 11 characters. required: false default: HA type: string {% endconfiguration %}

Usage

MessageBird is a notify platform and thus can be controlled by calling the notify action as described here. It will send a notification to the specified mobile phone number(s).

Example action payload

{
  "message": "A message for many people",
  "target": [ "+49123456789", "+43123456789" ]
}