---
layout: page
title: "Gitter Sensor"
description: "Instructions on how to integrate a Gitter room sensor with Home Assistant"
date: 2017-06-11 09:00
sidebar: true
comments: false
sharing: true
footer: true
logo: gitter.png
ha_category: Sensor
ha_release: 0.47
---


This `gitter` sensor allows one to monitor a [Gitter.im](https://gitter.im) chatroom for unread messages.

## {% linkable_title Configuration %}

Visit [Gitter Developer Apps](https://developer.gitter.im/apps) to retrieve your "Personal Access Token".

To use a Gitter sensor in your installation, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
sensor:
  - platform: gitter
    api_key: YOUR_API_TOKEN
```

{% configuration %}
api_key:
  description: Your Gitter.im API token.
  required: true
  type: string
room:
  description: Gitter room to monitor.
  required: false
  type: string
  default: home-assistant/home-assistant
{% endconfiguration %}
