MessageBird

The MessageBird notification integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] 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 configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.

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

Configuration Variables

api_key string Required

Your MessageBird API key.

name string (Optional, default: notify)

Setting the optional parameter name allows multiple notifiers to be created. The notifier will bind to the notify.NOTIFIER_NAME action.

sender string (Optional, default: HA)

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.

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" ]
}