Getting Started with Rumbliq: Monitor Your First API in 5 Minutes

This guide walks you through setting up Rumbliq from scratch: creating your account, adding your first monitor, configuring alerts, and understanding what Rumbliq will tell you when it detects API drift.

By the end, you'll have a live monitor watching a production API endpoint and a Slack alert configured to notify your team when something changes.

What You'll Need

Step 1: Create Your Account

Head to rumbliq.com/signup. You can sign up with:

After signing up, verify your email address. Rumbliq will send a verification link — click it to activate your account.

You'll land on the dashboard. It'll be empty for now — let's fix that.

Step 2: Add Your First Monitor

Click "New Monitor" in the top right of the dashboard, or navigate to Monitors → Create.

Basic Configuration

Name: Give your monitor a descriptive name. Something like Stripe Payment Intents or Shopify Products API is better than monitor_1. You'll thank yourself when you have 20 monitors.

URL: The endpoint URL to monitor. For example:

https://api.stripe.com/v1/payment_intents

Method: Defaults to GET. Change to POST, PUT, etc. if your endpoint requires a different method.

Check Interval: How often Rumbliq polls the endpoint.

For most critical third-party APIs, we recommend the shortest interval your plan allows.

Authentication

If your endpoint requires authentication, you have two options:

Option A — Direct header: Add an Authorization header with your Bearer token or API key directly in the Headers section. Fine for non-sensitive environments or tokens you rotate frequently.

Option B — Credential vault: For production use, store credentials in Rumbliq's encrypted credential vault (Pro and above). Vault credentials are stored with AES-256-GCM encryption. This is the recommended approach — your tokens stay encrypted at rest and are never exposed in plain text in the monitor configuration.

To add a vault credential:

  1. Navigate to Credentials in the sidebar
  2. Click "New Credential"
  3. Choose the type: Bearer, API Key, Basic Auth, OAuth2 Client, or Custom Headers
  4. Enter your credential details and save

Then, back in the monitor setup, select your credential from the Credential dropdown.

Request Body (for POST/PUT endpoints)

If your endpoint requires a request body, add it in the Body section as JSON. Rumbliq will send this body with every check.

For endpoints that require dynamic values (timestamps, nonces), consider using a stable test payload that returns a consistent schema structure.

Headers

Add any additional headers your endpoint requires beyond authentication:

Step 3: Import from OpenAPI, Postman, or cURL (Optional)

If you're setting up monitoring for multiple endpoints from the same service, import them in bulk:

OpenAPI / Swagger: Navigate to Monitors → Import → OpenAPI. Upload your .yaml or .json spec file. Rumbliq will parse it and pre-populate monitors for each endpoint, complete with correct HTTP methods, headers, and parameter structures.

Postman collection: Navigate to Monitors → Import → Postman. Export your collection from Postman as JSON and upload it here. Auth configs and example payloads are preserved.

cURL command: Navigate to Monitors → Import → cURL. Paste a cURL command and Rumbliq will extract the URL, method, headers, and body automatically. Useful for quickly converting curl commands from API documentation into monitors.

Step 4: Understand Your Baseline

When Rumbliq runs its first check on a new monitor, it establishes a baseline — the schema fingerprint of the current API response. This becomes the reference point for all future comparisons.

The baseline is stored automatically after the first successful check. You can view it by navigating to the monitor and clicking Baseline.

The baseline shows the structural schema Rumbliq extracted: field names, types, and nesting. It's human-readable — you can verify it looks like what you'd expect from that endpoint.

When to reset your baseline: If you intentionally update your integration to handle a new API response format, reset the baseline to accept the new schema as the reference point. Navigate to the monitor → Baseline → Reset to current. The old baseline is archived; the new one becomes active.

Step 5: Configure Alerts

By default, Rumbliq records all drift events in the check history, but doesn't send external notifications. To get alerted when drift is detected, configure at least one alert destination.

Navigate to Alerts in the sidebar and click "New Alert".

Slack

  1. Create an Incoming Webhook in your Slack workspace
  2. Select a channel for drift alerts (we recommend #api-alerts or #on-call)
  3. Paste the webhook URL into Rumbliq's Slack alert configuration
  4. Choose your alert severity threshold:
    • Any change: Alert on both breaking changes (removed fields, type changes) and non-breaking changes (added fields)
    • Breaking only: Alert only on changes that are likely to break your code

For most teams, Any change is the right default — you want to know about all schema drift, not just breaking changes.

Webhook

Webhooks let you integrate Rumbliq alerts into any system — PagerDuty, OpsGenie, a custom incident management tool, or your own API.

The payload Rumbliq sends to your webhook URL looks like:

{
  "event": "drift_detected",
  "monitor": {
    "id": "mon_abc123",
    "name": "Stripe Payment Intents",
    "url": "https://api.stripe.com/v1/payment_intents"
  },
  "check": {
    "id": "chk_xyz789",
    "timestamp": "2026-03-19T14:22:00Z",
    "severity": "breaking"
  },
  "diff": {
    "removed": ["data.items[].payment_method"],
    "added": ["data.items[].payment_method_details"],
    "typeChanges": []
  },
  "url": "https://rumbliq.com/monitors/mon_abc123/checks/chk_xyz789"
}

Email

For lower-urgency notifications or summary reports, configure email alerts. Enter the recipient address (or multiple addresses) and choose your severity threshold.

Step 6: Your First Drift Detection

Once your monitor is active, Rumbliq will check the endpoint on your configured interval. You can also trigger a manual check immediately by navigating to the monitor and clicking "Run Check Now".

On the Dashboard, you'll see:

On an individual Monitor Detail page:

Step 7: Join Your Team (Team Plan)

If you're on the Team plan, invite your colleagues:

  1. Navigate to Team in the sidebar
  2. Click "Invite Member"
  3. Enter their email address
  4. They'll receive an invitation email with a link to join your Rumbliq workspace

Team members share monitors, baselines, and alerts. Useful for on-call rotations where multiple engineers need visibility into the same integrations.

What to Monitor First

If you're not sure where to start, here are the highest-value endpoints to monitor:

Payment APIs — Any endpoint involved in payment processing, subscription management, or billing. Schema drift here can mean silent payment failures.

Identity/Auth APIs — OAuth token endpoints, user profile APIs, permission-check endpoints. Drift here can break login flows or access control.

Fulfillment APIs — Shipping, inventory, order status endpoints. Drift here affects your core product experience.

Notification APIs — Email/SMS/push APIs. Drift here means customers stop receiving critical communications.

Data sync APIs — CRM, analytics, data warehouse APIs. Drift here can silently corrupt your data pipeline.

For each integration your product depends on, ask: "If this API changed shape tomorrow, how quickly would we know?" If the answer is "not until a customer tells us," that endpoint is a candidate for Rumbliq monitoring.

Next Steps

Questions? Reach out at [email protected] or check the documentation.

Related Posts

Start monitoring your APIs free → — 25 monitors, 3 sequences, no credit card required.