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

title, description, ha_category, ha_iot_class, ha_release, ha_config_flow, ha_codeowners, ha_domain, ha_integration_type, ha_platforms, related

title	description	ha_category	ha_iot_class	ha_release	ha_config_flow	ha_codeowners	ha_domain	ha_integration_type	ha_platforms	related
Bring!	Instructions on how to integrate the Bring! todo list with Home Assistant.	To-do list	Cloud Polling	2024.2	true	@miaucl @tr4nt0r	bring	service	diagnostics sensor todo	docs title /integrations/todo To-do list integration documentation docs title /integrations/#to-do-list List of to-do list integrations docs title /dashboards/todo-list/ To-do list card url title https://www.getbring.com/ Bring!

The Bring! integration allows you to interact with your Bring! shopping lists within Home Assistant.

For authentication, the integration requires the email and password you used for your Bring! account. If you want to automatically receive notifications via the Bring! app when Home Assistant adds or removes an item from the list, you should use a dedicated account (such as email: your.name+ha@gmail.com) to connect Home Assistant with Bring!.

{% include integrations/config_flow.md %}

Sensors

• Urgent: Shows the number of items tagged with the Urgent badge on the shopping list. Completed items are excluded.
• On occasion: Displays the count of items marked with the If convenient badge.
• Discount only: Indicates the number of items tagged with the Offer badge.
• Region & Language: The sensor can be used for diagnostics. If everything is set correctly, it will display the selected region for the shopping list. If it shows Unknown, the region has not been set properly in the Bring! app.
• List access: Indicates whether the shopping list is personal (private) or shared (accessible to others).

Actions

You can use the actions from the to-do list to create, update, or delete items on your Bring! shopping lists.

Notifications

The Bring integration offers an action to send push notifications to the Bring! mobile apps of other members of a shared shopping list. The Bring! mobile app has 4 predefined notification types. Note: If you want to receive these notifications yourself, you need to use a dedicated account as mentioned above.

Data attribute	Optional	Description
target	no	Target Bring! list(s) whose members should be notified.
message	no	Type of push notification to send to list members. See Notification types.
item	yes	Required for urgent_message. Article name to include in the message. For example: Urgent Message - Please buy cilantro urgently.

Available notification types

Notification type	Text of notification
going_shopping	I'm going shopping! - Last chance to make changes
changed_list	List updated - Take a look at the articles
shopping_done	Shopping done - The fridge is well stocked
urgent_message	Urgent Message - Please buy Article name urgently

Sending a going shopping notification

...
actions:
  - action: bring.send_message
    target:
      entity_id: todo.bring_shoppinglist
    data:
      message: going_shopping 

Sending an urgent message notification

Note that for the notification type urgent_message the attribute item is required.

...
actions:
  - action: bring.send_message
    target:
      entity_id: todo.bring_shoppinglist
    data:
      message: urgent_message
      item: Cilantro