Recipes.

import * as Sentry from "@sentry/node";
import { checkupstream } from "@checkupstream/sdk";

checkupstream.init({
  apiKey: process.env.CHECKUPSTREAM_API_KEY,
  onError: (error, context) => {
    Sentry.captureException(error, {
      tags: {
        upstream_service: context.service,
        upstream_status: context.status,
      },
    });
  },
});

// In your Dashboard → Settings → Webhooks, add:
// URL: https://events.pagerduty.com/integration/
//      <YOUR_INTEGRATION_KEY>/enqueue
//
// Or use the API:
await fetch("/api/v1/webhooks", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer cup_...",
  },
  body: JSON.stringify({
    url: "https://events.pagerduty.com/integration/<KEY>/enqueue",
    events: ["incident.created", "incident.updated"],
    secret: "your-webhook-secret",
  }),
});

// 1. Go to Dashboard → Settings → Integrations
// 2. Click "Add to Slack"
// 3. Select a channel for notifications
// 4. Choose which events to receive:

// Supported events:
//   - incident.created    → New incident detected
//   - incident.resolved   → Incident resolved
//   - service.degraded    → Service degradation
//   - dependency.risk_changed → Risk score change

// Or configure via API:
await fetch("/api/v1/integrations/slack", {
  method: "POST",
  headers: { Authorization: "Bearer cup_..." },
  body: JSON.stringify({
    channel: "#ops-alerts",
    events: ["incident.created", "service.degraded"],
  }),
});

import { after } from "next/server";
import { checkupstream } from "@checkupstream/sdk";

checkupstream.init({
  apiKey: process.env.CHECKUPSTREAM_API_KEY,
});

export async function GET() {
  const data = await fetchUpstreamService();

  // Flush telemetry after the response is sent
  after(async () => {
    await checkupstream.flush();
  });

  return Response.json(data);
}

import express from "express";
import { checkupstream } from "@checkupstream/sdk";
import { expressMiddleware } from "@checkupstream/sdk/express";

const app = express();

checkupstream.init({
  apiKey: process.env.CHECKUPSTREAM_API_KEY,
});

// Add middleware — tracks all outgoing HTTP calls
app.use(expressMiddleware());

app.get("/api/users", async (req, res) => {
  // Calls to Stripe, OpenAI, etc. are
  // automatically tracked
  const users = await db.getUsers();
  res.json(users);
});

app.listen(3000);

name: Dependency Health Check
on:
  pull_request:
    branches: [main]
  schedule:
    - cron: "0 8 * * 1" # Weekly Monday 8am

jobs:
  check-upstream:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Run CheckUpstream scan
        run: npx @checkupstream/cli scan
        env:
          CHECKUPSTREAM_API_KEY: ${{ secrets.CHECKUPSTREAM_API_KEY }}

      - name: Check for critical risks
        run: npx @checkupstream/cli risk --fail-on critical
        env:
          CHECKUPSTREAM_API_KEY: ${{ secrets.CHECKUPSTREAM_API_KEY }}