Documentation

Integrate Watchup into your stack.

From frontend frameworks to backend services and terminal workflows, Watchup provides the tools to monitor everything with zero friction.

How it Works

Watchup is an all-in-one monitoring ecosystem designed to give you complete visibility into your applications' health. By combining external uptime monitoring with internal SDK tracking, we ensure you never miss an incident.

External Uptime Checks

Our global network of probe nodes performs pulse checks on your endpoints (HTTP/S) every few minutes. We monitor status codes, response headers, and latency to detect downtime or performance degradation instantly.

Internal SDK Tracking

While uptime checks monitor from the outside, our SDKs live inside your application. They automatically capture runtime exceptions, console errors, and custom event logs that wouldn't necessarily trigger a server failure.

Intelligent Alerting

When an incident is detected—whether it's a server timeout or a caught JS exception—Watchup routes the alert through your chosen channels. Get notified via Email, Slack, or Telegram within seconds.

Unified Dashboard

All your monitoring data, history, and active incidents are centralized in a beautiful, real-time dashboard. Organize your assets into Projects and manage everything through our Web UI or CLI.

Getting Started

To start using Watchup, you'll need your Project ID and API Key. You can find these in your dashboard under the settings or API section of your project.

Create Project

Set up a new workspace for your app.

Get Keys

Obtain your project identifiers.

Install SDK

Add Watchup to your codebase.

React / Next.js SDK

The watchup-react package is optimized for React applications, providing automatic state-aware tracking and a high-level UI component for provider initialization.

1. Installation

npm install watchup-react

2. Implementation (Next.js App Router)

Wrap your application in a client component to avoid hydration mismatches.

"use client";
import { WatchupProvider } from 'watchup-react';

export function WatchupClient({ children }) {
  return (
    <WatchupProvider 
      projectId="YOUR_PROJECT_ID" 
      apiKey="YOUR_API_KEY"
      baseUrl="https://watchup.space"
    >
      {children}
    </WatchupProvider>
  );
}

React Native SDK

The watchup-rn package brings production-grade error monitoring to your mobile applications, supporting both Bare React Native and Expo workflows.

1. Installation

npm install watchup-rn

2. Implementation

Wrap your root component with the WatchupProvider.

import { WatchupProvider } from 'watchup-rn';

const App = () => {
  return (
    <WatchupProvider
      projectId="YOUR_PROJECT_ID"
      apiKey="YOUR_API_KEY"
      baseUrl="https://watchup.space"
    >
      <MainApp />
    </WatchupProvider>
  );
};

3. Manual Capture

import { useWatchup } from 'watchup-rn';

const MyComponent = () => {
  const watchup = useWatchup();

  const handleError = (error) => {
    watchup?.captureError(error, { isFatal: false });
  };

  return <Button onPress={() => {
    try {
      // some logic
    } catch (e) {
      handleError(e);
    }
  }} title="Test" />;
};

SvelteKit SDK

Our SvelteKit SDK provides native hooks and simple initialization for high-performance Svelte applications.

Installation

npm install watchup-svelte

Manual Error Capture

import { captureException } from 'watchup-svelte'

try {
  runDangerousTask()
} catch (err) {
  captureException(err)
}

Universal JS SDK

The core SDK for manual exception and message handling across any JavaScript environment (Node.js, Browser, Deno).

Installation

npm install watchup-sdk

Capturing Events

import { initWatchup } from "watchup-sdk";

const watchup = initWatchup({
  apiKey: "YOUR_API_KEY",
  projectId: "YOUR_PROJECT_ID",
  environment: "production"
});

// Capture an exception
watchup.captureException(new Error("Something went wrong!"));

// Capture a message
watchup.captureMessage("Custom system log");

Python SDK

For server-side monitoring in Python, including Django, Flask, and FastAPI integrations.

from watchup_py import WatchupClient

client = WatchupClient(
    project_id="YOUR_PROJECT_ID",
    api_key="YOUR_API_KEY"
)

Watchup CLI

Manage your monitoring stack directly from the terminal. Perfect for automation and quick checks.

Installation

npm install -g watchup-cli

Authentication

watchup login

Management Commands

watchup projects:list

View all your projects

watchup monitors:list

Check monitor status

watchup whoami

Check current auth session

watchup monitors:create

Add a new monitor