rumbliq-starter

Ready-to-use API monitoring configurations for Rumbliq — the API schema drift detection platform.

What is this?

Pre-built monitoring configs for popular APIs. Drop them into your Rumbliq workspace and start detecting breaking changes in minutes.

Rumbliq watches your third-party API endpoints, detects schema drift (added/removed fields, type changes, structural shifts), and alerts you before your integration breaks.

Quick Start

Option 1: Use the init script

# Scaffold a monitoring config for any API
./rumbliq-init.sh https://api.example.com

# With a custom name
./rumbliq-init.sh https://api.stripe.com/v1 stripe-payments

Option 2: Copy an example config

Browse the examples/ directory and copy the YAML for your API:

cp examples/stripe.yaml my-stripe-monitors.yaml
# Edit endpoints, auth, and intervals to match your setup

Option 3: Import from OpenAPI spec

See docs/openapi-monitoring.md for setting up monitors directly from your OpenAPI/Swagger spec.

Example Configs

File	API	Endpoints	Description
stripe.yaml	Stripe	6	Payment intents, customers, subscriptions, invoices, products, prices
github.yaml	GitHub	5	Repos, users, issues, pulls, organizations
twilio.yaml	Twilio	5	Messages, calls, accounts, phone numbers, usage
slack.yaml	Slack	5	Conversations, users, channels, team info, auth test
openai.yaml	OpenAI	5	Models, chat completions, embeddings, assistants
rest-generic.yaml	Generic REST	3	Template for any REST API

Config Format

Each YAML file defines monitors that map to Rumbliq endpoint settings:

monitors:
  - name: "Stripe - List Customers"
    url: "https://api.stripe.com/v1/customers?limit=1"
    method: GET
    headers:
      Authorization: "Bearer ${STRIPE_SECRET_KEY}"
    interval: 300          # seconds between checks
    alertOnDrift: true     # notify when schema changes
    severity: critical     # alert severity: info, warning, critical

Fields

Field	Required	Description
name	Yes	Human-readable monitor name
url	Yes	Full endpoint URL
method	No	HTTP method (default: GET)
headers	No	Request headers (use ${ENV_VAR} for secrets)
body	No	Request body for POST/PUT/PATCH
interval	No	Check interval in seconds (default: 300)
alertOnDrift	No	Enable drift alerts (default: true)
severity	No	Alert severity: info, warning, critical (default: warning)
timeout	No	Request timeout in ms (default: 30000)
expectedStatus	No	Expected HTTP status code (default: 200)

Using with Rumbliq

1. Sign up at rumbliq.com
2. Create monitors — use the dashboard or import from these configs
3. Add credentials — store API keys securely in the credential vault
4. Get alerts — receive Slack, email, or webhook notifications when schemas drift

Automated Checks with GitHub Actions

This repo includes a GitHub Actions workflow (.github/workflows/check-apis.yml) that runs API schema checks on a schedule.

Setup:

1. Fork this repo
2. Add your API keys as repository secrets (e.g. STRIPE_SECRET_KEY, OPENAI_API_KEY)
3. Optionally add RUMBLIQ_API_KEY to report results back to your Rumbliq dashboard
4. The workflow runs every 6 hours by default, or on-demand via workflow_dispatch

Docs

• Setting up monitoring from OpenAPI specs

Contributing

Found a useful API config? PRs welcome! Please follow the existing YAML format and include:

• At least 3 endpoints per API
• Comments explaining each endpoint
• Placeholder auth using ${ENV_VAR} syntax

License

MIT

---

Built for Rumbliq — Detect API breaking changes before they break your app.