# pushover-mqtt

> Relay messages from MQTT to Pushover

Latest version **0.6.2** (published 2025-09-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install pushover-mqtt
pnpm add pushover-mqtt
yarn add pushover-mqtt
bun add pushover-mqtt
```

Provides the command `pushover-mqtt`.

## Health

**Score 45/100 (D)** — status: stable.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.6.2 |
| Published | 2025-09-23 |
| First published | 2018-06-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 7.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Den Williams |
| Maintainers | denwilliams |

## Links

- npm: https://www.npmjs.com/package/pushover-mqtt
- Repository: https://github.com/denwilliams/pushover-mqtt
- Homepage: https://github.com/denwilliams/pushover-mqtt#readme
- Issues: https://github.com/denwilliams/pushover-mqtt/issues
- npm.io page: https://npm.io/package/pushover-mqtt

## Dependencies (2)

- [mqtt-usvc](https://npm.io/package/mqtt-usvc.md) ^3.2.1
- [prom-client](https://npm.io/package/prom-client.md) ^15.1.3

## Recent versions

- 0.6.2 (latest) — 2025-09-23
- 0.6.1 — 2025-09-23
- 0.6.0 — 2025-09-23
- 0.5.0 — 2025-04-26
- 0.4.0 — 2023-07-22
- 0.3.0 — 2022-06-19
- 0.2.1 — 2020-04-27
- 0.2.0 — 2020-04-27
- 0.1.1 — 2018-06-30
- 0.1.0 — 2018-06-30

## README

# pushover-mqtt
Relay messages from MQTT to Pushover

**Breaking change in 0.3. `api_token` is now just `token`, and `user_key` just `user` to match the Pushover fields and documentation.**

## Topics

With a configured prefix of `pushover`, the following topics can be used:

- pushover/{target}/send/text
- pushover/{target}/send/message

Where `target` is the `key` of a target defined in configuration. Target configuration should contain at least `token` and `user`, but can contain any field defined here: https://pushover.net/api

`text` accepts a string payload which will be passed on as the message body to Pushover.

`message` accepts an object with any valid API field. These fields merge with the values in the target, so you can essentially define "default" values in the target, and override them in each message. Example fields include:

1. title (optional) - defaults to `target.title` if not provided
2. message (required)
3. url (optional)

Full list of fields available are: https://pushover.net/api

Examples:

- Topic: `pushover/send/jack/text`
- Payload: `Hi Jack!`

- Topic: `pushover/send/jack/message`
- Payload: `{"title":"Hello","message":"How are you?"}`

## Running

It is intended to be installed globally, ie `npm i -g pushover-mqtt`

Create a YAML file somewhere. See `config.example.yml`

You will need to define at least 1 target in the config.

Run (replace path)

```
CONFIG_PATH=/path/to/myconfig.yml pushover-mqtt
```

You can also use Consul for config. See [mqtt-usvc](https://www.npmjs.com/package/mqtt-usvc) for more details.

## Example Config

```yml
mqtt:
  uri: mqtt://localhost
  prefix: pushover
service:
  targets:
    # Will allow sending on pushover/send/myapp/text and pushover/send/myapp/message
    - key: myapp
      token: "setme"
      user: "setme"
      title: "My App"
```

---
_Source: https://npm.io/package/pushover-mqtt · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._