Skip to main content
Hugin AlertsHugin Alerts

Documentation

Everything you need to integrate Hugin into your workflow.

Documentation

Browse by topic

Getting Started

Quick introduction to Hugin and how to send your first notification.

  • Download the app
  • Your first event
  • Authentication

API Reference

Complete documentation of the event ingestion endpoint and parameters.

  • POST /v1/events
  • Request format
  • Response codes
Coming soon

Integrations

Pre-built examples for popular tools and platforms.

  • GitHub Actions
  • GitLab CI
  • Cron jobs
  • Bash scripts

Event Fields

Customize your events with system, component, and description fields.

  • system & event
  • component
  • description & url
Coming soon

Settings

Manage your ingest keys and notification preferences.

  • Ingest key management
  • Preferences
  • Delete data
Coming soon

Troubleshooting

Common issues and how to resolve them.

  • Connection issues
  • Delayed notifications
  • Authentication errors

Quick reference

API at a glance

POST /v1/events 
{
  "system": "string",         // max 80 chars
  "event": "string",          // max 120 chars
  "component": "string",      // max 160 chars
  "description": "string",    // max 500 chars
  "url": "string"            // opens on tap
}
201

Created

400

Bad request

401

Unauthorized

429

Rate limited