Skip to content

Never stop coding. Free MIT AI gateway: one endpoint, 375 providers (150+ free), 1,400+ models Kimi, Claude, GPT, Gemini, GLM, DeepSeek, MiniMax. Works with Claude Code, Codex, Cursor, OpenCode, Cline & Copilot. Quota-aware auto-fallback, RTK+Caveman compression saves 15-95% tokens, MCP/A2A, Desktop/PWA. Built by 900+ contributors

2.3 KB
Raw Blame
export type WebhookEvent =
  | "request.completed"
  | "request.failed"
  | "quota.exceeded"
  | "proxy.set_aside"
  | "proxy.pool.exhausted"
  | "test.ping";

export const WEBHOOK_EVENT_VALUES = [
  "request.completed",
  "request.failed",
  "quota.exceeded",
  "proxy.set_aside",
  "proxy.pool.exhausted",
  "test.ping",
] as const;

export interface EventDescription {
  label: string;
  description: string;
  emoji: string;
  exampleData: Record<string, unknown>;
}

export const EVENT_DESCRIPTIONS: Record<WebhookEvent, EventDescription> = {
  "request.completed": {
    label: "Request Completed",
    emoji: "✅",
    description: "Triggered when an upstream request completes successfully (HTTP 2xx).",
    exampleData: {
      model: "claude-opus-4-7",
      provider: "claude",
      latencyMs: 1240,
      tokensIn: 142,
      tokensOut: 38,
    },
  },
  "request.failed": {
    label: "Request Failed",
    emoji: "🚨",
    description: "Triggered when a request fails after all retries and fallback combo targets.",
    exampleData: {
      model: "claude-opus-4-7",
      provider: "claude",
      error: "503 Service Unavailable",
      attempts: 3,
    },
  },
  "quota.exceeded": {
    label: "Quota Exceeded",
    emoji: "📊",
    description: "A usage threshold (e.g. 95% of quota) was reached.",
    exampleData: { quota: "daily_tokens", used: 950000, limit: 1000000, pct: 95 },
  },
  "proxy.set_aside": {
    label: "Proxy Set Aside",
    emoji: "🚧",
    description:
      "Triggered when a pool member is temporarily set aside after repeated refusals. Transition only, never per request.",
    exampleData: {
      reason: "ip_quota_429",
      setAsideUntil: "2026-09-24T12:40:00.000Z",
      durationMs: 60000,
      egressKeyMasked: "https://u***@ho***le:8080",
    },
  },
  "proxy.pool.exhausted": {
    label: "Proxy Pool Exhausted",
    emoji: "🪫",
    description:
      "Triggered when every member of a pool scope is set aside and selection falls back to fail-closed serving.",
    exampleData: {
      scope: "global",
      poolSize: 3,
      setAsideCount: 3,
      fallback: "fail-closed-serve",
    },
  },
  "test.ping": {
    label: "Test Ping",
    emoji: "🏓",
    description: "Manual test delivery to verify your webhook is reachable.",
    exampleData: { message: "Test ping from OmniRoute", webhookId: "preview" },
  },
};