Documentation — GreenPing

Quick Start

Create your first status page in 2 minutes

Quick Start

1. Create your account

2. Create a status page

Click "New Page" and enter your page name and URL slug. Your page will be available at greenping.live/s/your-slug.

3. Add your components

Components are the services you want to display (e.g., API, Website, Database). Add them from the Components tab. Each component has a status:

Operational — everything is working normally
Degraded — reduced performance but functional
Partial Outage — some users are affected
Major Outage — service is unavailable
Maintenance — planned downtime

4. Share your status page

Share your public URL with your customers. The page is edge-cached and globally distributed — it stays online even if your infrastructure doesn't. Custom domain support is coming soon.

Webhooks

Supported monitoring tools

UptimeRobot — sends alert type (up/down) automatically
Checkly — sends check results with failure status
Pingdom — sends current state (UP/DOWN)
Generic — any tool that can send HTTP POST requests

Setting up a webhook

Go to your status page → Webhooks tab
Click "Add Webhook"
Select the source (UptimeRobot, Checkly, etc.) and target component
Copy the generated webhook URL
Paste it into your monitoring tool's webhook/notification settings

Generic webhook format

Send a POST request with this JSON body:

POST /api/webhooks/incoming/{webhook_id}
Content-Type: application/json

{
  "status": "major_outage",
  "message": "API server is not responding"
}

When status is major_outage or partial_outage, an incident is auto-created. When operational, active incidents are auto-resolved.

API Reference

All API endpoints require authentication via Bearer token (available on Pro and Team plans). Include your access token in the Authorization header.

Quick status update

Change a component's status with a single call:

curl -X PATCH \
  https://api.greenping.live/api/pages/{page_id}/components/{id}/status?status=major_outage \
  -H "Authorization: Bearer YOUR_TOKEN"

Create an incident

curl -X POST \
  https://api.greenping.live/api/pages/{page_id}/incidents \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Database connectivity issues",
    "severity": "major",
    "message": "We are investigating connection timeouts.",
    "affected_components": ["component_id"],
    "status": "investigating"
  }'

Resolve an incident

curl -X POST \
  https://api.greenping.live/api/pages/{page_id}/incidents/{id}/resolve \
  -H "Authorization: Bearer YOUR_TOKEN"

Auto-resolves the incident, posts a "resolved" update, and resets affected components to operational.

All endpoints

Method	Endpoint	Description
GET	/api/pages	List your pages
POST	/api/pages	Create a page
GET	/api/pages/{id}/components	List components
PATCH	/api/pages/{id}/components/{id}/status	Update status
POST	/api/pages/{id}/incidents	Create incident
POST	/api/pages/{id}/incidents/{id}/updates	Post update
POST	/api/pages/{id}/incidents/{id}/resolve	Resolve

Custom Domains (Coming Soon)

Custom domain support — pointing your own subdomain like status.yourcompany.com to your GreenPing page — is on the roadmap and will be available soon. For now, every status page lives at greenping.live/s/your-slug and is fully shareable.

Email Notifications

How it works

A "Subscribe to updates" form appears on your public status page
Users enter their email and receive a confirmation link (double opt-in)
Once confirmed, they receive emails for all incident activity
Every email includes an unsubscribe link

Subscriber limits by plan

Plan	Confirmed Subscribers
Free	100
Pro ($9/mo)	1,000
Business ($29/mo)	5,000

There is no limit on emails sent per month — the cap is on total confirmed subscribers per status page.