https://github.com/hookflo/notify-action
A simple and Quick, production ready GitHub Action to send JSON alerts and notifications via POST requests to Slack, email services, logging endpoints, and more.
https://github.com/hookflo/notify-action
alerting logging monitoring observability
Last synced: 3 months ago
JSON representation
A simple and Quick, production ready GitHub Action to send JSON alerts and notifications via POST requests to Slack, email services, logging endpoints, and more.
- Host: GitHub
- URL: https://github.com/hookflo/notify-action
- Owner: Hookflo
- License: mit
- Created: 2025-07-17T16:50:51.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-18T18:32:52.000Z (11 months ago)
- Last Synced: 2026-01-02T14:25:07.740Z (6 months ago)
- Topics: alerting, logging, monitoring, observability
- Homepage: https://www.hookflo.com
- Size: 6.84 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📡 HookFlo Notify Action
A lightweight GitHub Action by [**HookFlo**](https://hookflo.com) to send JSON notifications to any HTTP endpoint using secure token headers. Ideal for Slack alerts, email notifications, CI/CD event tracking, or internal monitoring.
---
## ✨ Why HookFlo?
- 🔗 **Centralized Webhook Management** — Create & manage secure webhooks from your [HookFlo Dashboard](https://hookflo.com).
- 🎨 **Custom Templates** — Design Slack or Email notification templates without code.
- 📊 **Real-Time Logs** — Monitor delivery and debug failures from your HookFlo Dashboard.
- 🛡️ **Secure By Default** — Token-based authentication for every request.
> 🚀 **[Sign up at HookFlo](https://hookflo.com)** to get your Webhook URL, ID, and Secret.
---
## 🚀 Features
- ✅ **Minimal Setup** — Just URL, token, and payload.
- ✅ **Flexible JSON Payloads** — Send any event data.
- ✅ **Secure Headers** — `x-webhook-token` and `x-webhook-id` included.
- ✅ **Zero Dependencies** — Fast, Docker-free execution.
---
## 📦 Inputs
| Input Name | Description | Required |
|-------------------|---------------------------------------------------|----------|
| `webhook_url` | Your Webhook URL from HookFlo. | ✅ Yes |
| `webhook_id` | Webhook ID used in `x-webhook-id` header. | ✅ Yes |
| `webhook_secret` | Secret token used in `x-webhook-token` header. | ✅ Yes |
| `payload` | Optional JSON payload to send as request body. | ❌ No |
---
## 🛠️ Setup Instructions
1. **[Sign up on HookFlo](https://hookflo.com)**
2. **Create a Custom Webhook** — Copy your Webhook URL, ID, and Secret.
3. **Set Up Templates** — Customize Slack or Email notifications in your dashboard.
4. **Monitor Logs** — View delivery history and debug from HookFlo's real-time dashboard.
---
## 📄 Example Workflow
```yaml
- name: Send Notification via HookFlo
uses: hookflo/hookflo-notify-action@v1.5
with:
webhook_url: ${{ secrets.HOOKFLO_URL }}
webhook_id: ${{ secrets.WEBHOOK_ID }}
webhook_secret: ${{ secrets.WEBHOOK_SECRET }}
payload: |
{
"event": "deployment_failed",
"repository": "${{ github.repository }}",
"branch": "${{ github.ref }}",
"run_id": "${{ github.run_id }}",
"status": "failed"
}