Cisco Webex Teams

The cisco_webex_teams notification platform allows you to deliver rich notifications from Home Assistant to Cisco Webex Teams (formerly known as Cisco Spark).

To use this notification platform you will need an app (bot) token. To obtain a token visit Cisco Webex for Developers.

You also need to specify the room_id that you wish to post messages into. The room_id can be found in one of two ways:

  1. Logging in at Cisco Webex for Developers and navigate to Documentation>API Reference>Messages and select List Messages, or
  2. Log into the web client at,
    • select the room (or create a new room),
    • then copying the room ID from the URL.

You must add the bot email (in the format [email protected]) as a participant to the room specified above.

To enable this platform in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
    platform: cisco_webex_teams
    token: YOUR_BOT_TOKEN

Rich Text Formatting

Webex Teams clients can render rich text via a whitelisted set of html tags.

For example, you could configure automations to display details in an easy to read fashion like so:

Rich text as displayed in the macOS client.

Here are the automations for the above screenshot:

# Rich Text Example 1.
# Show a one line message with a red banner
- alias: "Notify On Build Failing"
    - platform: webhook
      webhook_id: build_failed
    service: notify.cisco_webex_teams_notify
      message: "<blockquote class=danger>Build 0.89.5 compile failed."

# Rich Text Example 2.
# Show a title and multi-line message with a yellow banner, 
# with lists, a person mention and a link
- alias: "Notify On Build Unstable"
    - platform: webhook
      webhook_id: build_unstable
    service: notify.cisco_webex_teams_notify
      title: "<strong>Build 0.89.6 is unstable.</strong>"
      message: "<blockquote class=warning>Version 0.89.6 failed verifications.
        <li> test_osx
        <li> test_win_lint

        <li>... and 4 more.
      <p><@personEmail:[email protected]></p>
      <p><small><i>View <a href='https://demo/testReport/'>Test Report</a></i></small><br></p>

# Rich Text Example 3.
# Show a title and multi-line message with a blue banner, 
# with lists, a person mention and a link
- alias: "Notify On Build Passing"
    - platform: webhook
      webhook_id: build_passed
    service: notify.cisco_webex_teams_notify
      title: "<strong>✅ Version 0.89.7 passed all tests and deployed to production!</strong>"
      message: "<blockquote class=info>Version 0.89.7 passed all verifications.
        <li> test_cov
        <li> test_osx
        <li> test_win
        <li> test_linux
        <li>... and 45 more.

The following is a list of the allowed html tags and attributes:

Tag More Info
<@personEmail:[email protected]> Used to tag another Webex Team user by email address.
<a> Defines a hyperlink. Allows attribute href.
<blockquote> Defines a section that is quoted from another source. Allows attribute class with allowed values danger, warning, info, primary, secondary.
<b> Defines bold text.
<strong> Defines important text.
<i> Defines italic text.
<em> Defines emphasized text.
<pre> Defines preformatted text.
<code> Defines a piece of computer code.
<br> Defines a single line break.
<p> Defines a paragraph.
<ul> Defines an unordered list.
<ol> Defines an ordered list.
<li> Defines a list item.
<h1> to <h3> Defines HTML headings.

Configuration Variables

name string (Optional, default: notify)

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

token string Required

Your app (bot) token.

room_id string Required

The Room ID.

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