Browse Docs

cURL / HTTP

No SDK or CLI needed. Any tool that can make an HTTP request can send notifications to API Alerts.

Basic Request

curl -X POST https://api.apialerts.com/event \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "message": "Hello from API Alerts!" }'

With All Options

curl -X POST https://api.apialerts.com/event \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "New user signed up",
    "channel": "signups",
    "link": "https://dashboard.example.com/users/123",
    "tags": ["signup", "organic"]
  }'

Request Body

FieldRequiredDescription
messageYesThe notification message
channelNoTarget channel (defaults to workspace default)
linkNoURL to attach to the notification
tagsNoArray of tags for categorization

Examples

Shell script

#!/bin/bash
curl -s -X POST https://api.apialerts.com/event \
  -H "Authorization: Bearer $APIALERTS_API_KEY" \
  -H "Content-Type: application/json" \
  -d "{ \"message\": \"Backup completed\", \"tags\": [\"backup\", \"cron\"] }"

Cron job

# Notify every hour that a health check passed
0 * * * * curl -s -X POST https://api.apialerts.com/event -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{ "message": "Health check OK" }'

PowerShell

Invoke-RestMethod -Uri "https://api.apialerts.com/event" `
  -Method Post `
  -Headers @{ "Authorization" = "Bearer YOUR_API_KEY"; "Content-Type" = "application/json" } `
  -Body '{ "message": "Deploy completed" }'

Python (no SDK)

import requests

requests.post("https://api.apialerts.com/event",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"message": "Task finished"})

Resources

  • API Reference — Full API documentation with all endpoints and error codes