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

title	description	ha_category	ha_iot_class	ha_release	ha_domain	ha_platforms	ha_integration_type	related	ha_quality_scale
Joaoapps Join	Instructions for how to integrate the Join by Joaoapps service within Home Assistant.	Hub Notifications	Cloud Push	0.24	joaoapps_join	notify	integration	docs title /docs/configuration/ Configuration file	legacy

The joaoapps_join {% term integration %} exposes actions from Join. In Home Assistant, the Joaoapps Join features are divided up in two locations, the Join integration, and the Joaoapps Join notify platform. The notify platform allows us to send messages to Joaoapps Join devices, the integration allows us to access the other special features that Joaoapps Join offers. When in doubt, you can reference the API documentation this is based on.

In the {% term "configuration.yaml" %} file you need to provide the API key and device id or name of the target device. You can find your device id and API key here.

To set it up, add the following information to your {% term "configuration.yaml" %} file. {% include integrations/restart_ha_after_config_inclusion.md %}

# Example configuration.yaml entry
notify:
  - platform: joaoapps_join
    api_key: YOUR_API_KEY
    device_id: DEVICE_ID
    device_ids: DEVICE_ID_1,DEVICE_ID_2
    device_names: DEVICE_1_NAME,DEVICE_2_NAME
    name: NAME
joaoapps_join:
  - name: NAME_OF_GROUP
    device_id: GROUP.GROUP_NAME
    api_key: YOUR_API_KEY

{% configuration %} api_key: description: The API key for Join. required: true type: string device_id: description: The id of your device or group required: false type: string device_ids: description: Comma separated list of device ids or groups. required: false type: string device_names: description: Comma separated list of device names. required: false type: string name: description: The name parameter is optional but needed if you want to use multiple notification platforms. The platform will be exposed as notify.<name> action. The name will default to notify if not supplied. See the Notifications integration for more details. required: false type: string {% endconfiguration %}

Use only one of device_id, device_ids, or device_names, this will determine the notification recipient(s).

# Example configuration.yaml entry
notify:
  - platform: joaoapps_join
    api_key: YOUR_API_KEY
    device_id: DEVICE_ID1
    name: NAME1
  - platform: joaoapps_join
    api_key: YOUR_API_KEY
    device_id: DEVICE_ID2
    name: NAME2

The notify action has several optional parameters: icon, smallicon, image, sound, url, notification_id, category, tts, tts_language and vibration. You can use them like so:

message: Hello from Home Assistant!
title: Home Assistant
data:
  icon: https://goo.gl/xeetdy
  smallicon: https://goo.gl/xeetdy
  vibration: 0,65,706,86,657,95,668,100
  image: https://www.home-assistant.io/images/favicon-192x192-full.png
  sound: https://goo.gl/asasde.mp3
  url: https://home-assistant.io
  notification_id: hass-notification
  category: Custom Notification Category
  tts: Notification from Home Assistant
  tts_language: english
  actions:
    Netflix:
    Tweet:
      - Tweet from HASS!
    Sleep:

The actions exposed in the joaoapps_join integration can be used with the action data described below:

Action	Data
joaoapps_join/ring
joaoapps_join/send_sms	{"number":"5553334444", "message":"Hello!"}
joaoapps_join/send_tasker	{"command":"test"}
joaoapps_join/send_url	{"url":"http://google.com"}
joaoapps_join/send_wallpaper	{"url":"http://www.planwallpaper.com/static/images/ZhGEqAP.jpg"}
joaoapps_join/send_file	{"url":"http://download.thinkbroadband.com/5MB.zip"}