Sygnal Hyperflow
Micro-Consulting
  • 📗Overview
    • Hyperflow v2.0
    • What's New?
  • 📗CORE FEATURES
    • Overview
    • SEO Enhancements
    • Hyperflow 2 API
    • Logging
  • 📗HYPERFLOW APPS
    • Hyperflow Monitor
      • API
      • Alert Setup
    • Hyperflow Locale-Specific Domains
    • Hyperflow LLMS
      • Setting up LLMS.TXT
      • Setting up Markdown Pages
      • Hyperflow LLMS API
      • Future
    • Hyperflow CMS Preview
    • Hyperflow Files
    • Hyperspeed
  • 📗INSTALLATION
    • Hyperflow Setup
    • Cloudflare DNS Setup
      • GoDaddy
    • Hyperflow Installation
    • Micro-service RPC Interface
    • Monitoring & Maintenance Setup
  • 📗HYPERSPEED
    • About Hyperspeed
    • Hyperspeed Releases
    • Hyperspeed Caching Features
      • Purge Cache on Site Publish
    • Hyperspeed Security Features
    • Hyperspeed SEO Features
    • Hyperspeed Advanced & Custom Features
    • Hyperspeed Monitoring & Maintenance
    • Additional Notes
      • Hyperspeed API
      • Monitoring
      • Information
      • JS
      • CSS
      • Hyperflow Purge Cache
        • Purge Triggers
        • Purge HTML Only
        • Quickstart
      • Content Coverage
      • Special File Handling
      • Caching
      • Image Handler
      • Dev Setup
      • Hyperflow Inline SVGs
      • Hyperflow Image Optimization
    • Hyperflow Editor
    • Future
    • Webflow Notes
    • Troubleshooting
  • 📗ADVANCED HYPERSPEED
    • Kingside Castle (O-O)
    • Queenside Castle (O-O-O)
Powered by GitBook
On this page
  • Get monitor info
  • Ping monitor
  • Test monitor alerting
  • Add monitor
  • Update monitor
  1. HYPERFLOW APPS
  2. Hyperflow Monitor

API

The Hyperflow Monitor API

PreviousHyperflow MonitorNextAlert Setup

Last updated 10 months ago

Monitor ID's can be any unique arbitrary string, but we recommend UUIDs.

For the API calls, ensure it is properly URL encoded.

Get monitor info

GET /(monitor-id)

Returns the information on the specified monitor.

Response

{
    "name": "Monitor 1",
    "id": "8ad4a5dc-5481-4973-aa99-e0183904528d",
    "interval": 2880,
    "message": null,
    "alert_ping": null,
    "alert_timeout": null,
    "timeout": "2024-08-10T22:07:55.173Z"
}
{
  "status": "error",
  "message": "Invalid request"
}
{
  "status": "error",
  "message": "No match found"
}

Ping monitor

GET /(monitor-id)/ping

Records the ping event.

Response

{
  "status": "success",
  "message": "Operation completed successfully.",
  "data": {
    "timeout": "2024-08-10T22:07:55.173Z" 
  }
}
{
  "status": "error",
  "message": "Invalid request"
}
{
  "status": "error",
  "message": "No match found"
} 
{
  "status": "error",
  "message": "Failed to update monitor"
}

Test monitor alerting

GET /(monitor-id)/test

Performs alerting on both ping and timeout.

Response

{
  "status": "success",
  "message": "Test alert sent"
}
{
  "status": "error",
  "message": "Invalid request"
}
{
  "status": "error",
  "message": "Monitor not found"
} 
{
  "status": "error",
  "message": "Failed to send alert"
}

Add monitor

POST /

Create a new monitor

Body

Name
Type
Description

id

string

( optional ). If unspecified, monitor instance is assigned a UUID

name

string

Name of the monitor

interval

number

Timeout interval ( in mins )

message

string

The message to send

alert_ping

string

The alerting profile to use

alert_timeout

string

The alerting profile to use for timeout events

Example;

{
    "name": "Test",
    "interval": 2880,
    "message": "A new booking was made",
    "alert_ping": "sygnal-pushbullet",
    "alert_timeout": "sygnal-pushbullet"
}

Response

{
  "status": "success",
  "message": "Test alert sent",
  "data": {
    "id": "8ad4a5dc-5481-4973-aa99-e0183904528d" 
  }
}
{
  "status": "error",
  "message": "Invalid request"
}
{
  "status": "error",
  "message": "Monitor not found"
} 
{
  "status": "error",
  "message": "Failed to send alert"
}

Update monitor

PATCH /(monitor-id)

Update a monitor

Body

Name
Type
Description

name

string

Name of the monitor

interval

number

Timeout interval ( in mins )

message

string

The message to send

alert_ping

string

The alerting profile to use

alert_timeout

string

The alerting profile to use for timeout events

Response

{
  "status": "success",
  "message": "Monitor updated" 
}
{
  "status": "error",
  "message": "Invalid request"
}
{
  "status": "error",
  "message": "Monitor not found"
} 
{
  "status": "error",
  "message": "Failed to send alert"
}

📗
https://www.uuidgenerator.net/version4