API Documentation

1. Obtain a token

POST your credentials to the login endpoint. The response contains a token field.

POST /api/v1/auth/login
Content-Type: application/json

{
  "email": "[email protected]",
  "password": "your-password"
}

2. Use the token

Pass the token in the Authorization header on all protected requests.

GET /api/v1/monitors
Authorization: Bearer <your-token>

Step 1 — Create a Slack Incoming Webhook

In Slack, go to Apps → Incoming Webhooks (or visit api.slack.com/apps), create a new app, enable Incoming Webhooks, and add it to a channel. Copy the generated webhook URL.

Step 2 — Create the alert channel

POST /api/v1/alert-channels
Authorization: Bearer <token>
Content-Type: application/json

{
  "name": "Slack Alerts",
  "type": "slack",
  "config": {
    "webhook_url": "https://hooks.slack.com/services/T.../B.../..."
  }
}

What alerts look like

Down alerts appear as plain text messages with the monitor name, URL, and failure cause. Recovery alerts confirm when the monitor comes back online. Vartio sends a plain text field so messages display in any Slack client without attachments.

Step 1 — Create a Discord Webhook

In your Discord server, open Channel Settings → Integrations → Webhooks, create a new webhook, choose a channel, and copy the webhook URL.

Step 2 — Create the alert channel

POST /api/v1/alert-channels
Authorization: Bearer <token>
Content-Type: application/json

{
  "name": "Discord Alerts",
  "type": "discord",
  "config": {
    "webhook_url": "https://discord.com/api/webhooks/..."
  }
}

Format note

Discord webhooks use an embeds array rather than a plain text field. Vartio automatically formats the payload to match Discord's expected structure — no extra configuration is required on your end.

Create the alert channel

POST /api/v1/alert-channels
Authorization: Bearer <token>
Content-Type: application/json

{
  "name": "My Webhook",
  "type": "webhook",
  "config": {
    "url": "https://example.com/hooks/vartio",
    "secret": "optional-shared-secret"
  }
}

If secret is provided, Vartio sends it in the X-Webhook-Secret header so you can verify the request origin.

Payload format

Vartio sends a JSON body with Content-Type: application/json. The type field is either down or recovery. The cause field is omitted on recovery events.

{
  "type": "down",
  "monitor_name": "Production API",
  "monitor_url": "https://api.example.com/health",
  "cause": "connection refused",
  "incident_id": "01932b4c-...",
  "occurred_at": "2025-01-15T10:30:00Z"
}

Add an email recipient

Create an alert channel with type: email and set the destination address in config.email. You can create as many email channels as needed — each one delivers to a separate inbox.

POST /api/v1/alert-channels
Authorization: Bearer <token>
Content-Type: application/json

{
  "name": "On-call Engineering",
  "type": "email",
  "config": {
    "email": "[email protected]"
  }
}

Subject line format

Down alerts arrive with the subject [DOWN] <monitor name> is unreachable. Recovery alerts use [RECOVERED] <monitor name> is back online, making it easy to set up email filters.