2024.11.3
Home ▸ Integrations ▸

Clickatell

The clickatell platform uses Clickatell to deliver SMS notifications from Home Assistant.

Setup

Go to your Clickatell SMS Platform Portal section and create a new SMS integration. There are three screens of information required to create an integration. Please ensure the following:

  1. Give the new Integration an identification name.
  2. Ensure it is set for ‘production’ use.
  3. Select ‘HTTP’ as your API type.
  4. Ensure that the you select for the messaging type to be ‘one way messaging’.
  5. Be aware of the international number format option as this impacts the structure of the phone numbers you provide.
  6. Once you have completed entering your details an API key is generated. Copy the API key.

Configuration

To add Clickatell to your installation, add the following to your Home Assistant 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:
  - platform: clickatell
    name: USER_DEFINED_NAME
    api_key: CLICKATELL_API_KEY
    recipient: PHONE_NO

Configuration Variables

Looking for your configuration file?
name string (Optional, default: clickatell)

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

api_key string Required

Your Clicktell API key.

recipient string Required

Your phone number. This is where you want to send your notification SMS messages. e.g., 61444333444.

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

Related topics