# BoopEx v1.0.0 - Table of Contents

> Elixir client for Boop, the tiny self-hosted push notification inbox.

## Pages

- [BoopEx](readme.md)
- [Changelog](changelog.md)
- [boop_ex usage rules](usage-rules.md)

## Modules

- [Boop](Boop.md): Send events to a self-hosted [Boop](https://github.com/chrisgreg/boop) server.
- [Boop.Client](Boop.Client.md): The HTTP layer, built on `Req`. You normally call `Boop.send/2` instead.
- [Boop.Config](Boop.Config.md): Resolved configuration for a send. Values come from per-call options, then the
`:boop_ex` application environment, then the `BOOP_URL` / `BOOP_API_KEY` environment variables.

- [Boop.Error](Boop.Error.md): Why a send failed. Returned as `{:error, %Boop.Error{}}`; never raised.
- [Boop.Event](Boop.Event.md): An event to send to Boop. Only `title` is required.
- [Boop.Redactor](Boop.Redactor.md): Replaces the values of sensitive keys anywhere inside event data with `"[REDACTED]"`.