# Honk

> Honk is a calm inbox for events from anything that can call a URL: apps, scripts, cron jobs, CI, servers, online shops, forms and home automations. One HTTPS request (POST /v1/messages) sends an event; Honk groups repeats into episodes and pushes only the first sign of trouble to iPhone, Apple Watch and the browser, then calm updates.

- Sending: `POST https://honk-me.app/v1/messages` with `Authorization: Bearer <ingestion key>` and a JSON body; `message` is the only required field. `202` means durably stored, not pushed.
- Use `group_key` so repeats of one problem fold into one group; `event_type: "problem"` and `"recovery"` open and close an incident for that key.
- Severity takes `info | success | warning | error | critical` or the horn aliases `light | beep | loud | long | blast`.
- Send an `Idempotency-Key` header that stays the same for the same event; retries within 24 h return the original id.
- Keep the ingestion key (`honk_…`) on servers and in CI secrets, never in browser, mobile or desktop apps.
- Honk is invite-only for now: people request access at https://honk-me.app/request-access.

## Docs

- [Sending events](https://honk-me.app/docs.md): the request, every field, responses, idempotency and the Honk scale
- [OpenAPI 3.1](https://honk-me.app/docs/openapi.yaml): the ingestion API as an OpenAPI document
- [How Honk works](https://honk-me.app/how-it-works): groups, episodes, what gets pushed, quiet hours, digests, workspaces and projects

## Libraries (MIT, README on GitHub)

- [Laravel and PHP](https://raw.githubusercontent.com/honk-me/honk-php/main/README.md): Facade, notification channel, exception reporting, scheduler hooks and Honk::fake() for Laravel 13. A plain client for any PHP 8.3 app. Page: https://honk-me.app/integrations/laravel
- [Node.js](https://raw.githubusercontent.com/honk-me/honk-node/main/README.md): TypeScript client with ESM and CommonJS builds and no dependencies. Runs on Node 18+, Bun and Deno. Page: https://honk-me.app/integrations/node
- [Go](https://raw.githubusercontent.com/honk-me/honk-go/main/README.md): Context-aware client, standard library only, safe for concurrent use. Ships with the honk-me CLI. Page: https://honk-me.app/integrations/go
- [Swift](https://raw.githubusercontent.com/honk-me/honk-swift/main/README.md): Swift 6.2 client with strict concurrency and async/await, for server-side Swift, macOS tools and Linux. Page: https://honk-me.app/integrations/swift
- [Kotlin and Java](https://raw.githubusercontent.com/honk-me/honk-kotlin/main/README.md): Suspend API for Kotlin, blocking and CompletableFuture for Java, on java.net.http. JDK 17+. Page: https://honk-me.app/integrations/kotlin
- [Rust](https://raw.githubusercontent.com/honk-me/honk-rust/main/README.md): Async client on Tokio and reqwest with rustls, plus a blocking client. Rust 1.85+, no unsafe code. Page: https://honk-me.app/integrations/rust
- [CLI and cURL](https://raw.githubusercontent.com/honk-me/honk-go/main/README.md): The honk-me command for shell scripts, cron and CI, or a single cURL request. Page: https://honk-me.app/integrations/cli
- [n8n](https://raw.githubusercontent.com/honk-me/honk-n8n/main/README.md): A community node with one action, Honk → Send message, and an idempotency key on every item. Page: https://honk-me.app/integrations/n8n

## Guides

- [WooCommerce order notifications with Honk Me](https://honk-me.app/guides/woocommerce-order-notifications.md): A WordPress plugin sends Honk your orders, failed payments, stock alerts and form entries. You choose what each notification says.
- [Form submissions to your phone](https://honk-me.app/guides/form-submissions-to-your-phone.md): Every contact or quote form submission as a push with all its fields, from WordPress, hosted form tools or your own code.
- [Website down alerts on your iPhone](https://honk-me.app/guides/website-down-alerts.md): One push when your site goes down and one when it’s back up, from a cron check or Uptime Kuma.
- [Home Assistant alerts on your iPhone](https://honk-me.app/guides/home-assistant-iphone-alerts.md): A rest_command for configuration.yaml, a leak alert that folds its repeats, and a doorbell with a snapshot.
- [n8n workflow notifications on your iPhone](https://honk-me.app/guides/n8n-workflow-notifications.md): The Honk node or the HTTP Request node, plus an error workflow that reports every failed execution.
- [Push notifications from a cron job](https://honk-me.app/guides/cron-job-push-notifications.md): One crontab line that honks when a job fails, and a wrapper that also tells you when it works again.
- [GitHub Actions failure alerts on your iPhone](https://honk-me.app/guides/github-actions-failure-alerts.md): One workflow step that pushes a failed run, folded per repository and branch, plus an optional recovery.
- [Laravel exception notifications on your phone](https://honk-me.app/guides/laravel-exception-notifications.md): One line in bootstrap/app.php, throttled per exception, plus scheduler hooks and a fake for tests.
- [Customer requests from your app to your phone](https://honk-me.app/guides/customer-requests-to-your-phone.md): Each new quote or contact request as one push with its details, ready to answer from your phone.
- [Deploy notifications from any CI](https://honk-me.app/guides/deploy-notifications.md): A failed deploy pushes right away and the next good one closes it. One pattern for GitHub Actions, GitLab CI and shell scripts.
- [Stop alert fatigue with fewer, better notifications](https://honk-me.app/guides/stop-alert-fatigue.md): Why repeats teach you to ignore alerts, and six habits that fix it, plus a checklist for group keys.

## Optional

- [Pricing and limits](https://honk-me.app/pricing)
- [Privacy Policy](https://honk-me.app/privacy)
- [Support](https://honk-me.app/support)
- The site in Romanian, Spanish, French and German: https://honk-me.app/ro, https://honk-me.app/es, https://honk-me.app/fr, https://honk-me.app/de (guides have .md twins in each language)