Documentation

Web

Add one script tag before the closing body tag on every page you want watched:

<script src="https://probie.dev/assets/probie-widget.js" data-token="YOUR_WIDGET_TOKEN"></script>

This bundle renders a small "Report an issue" button and loads the passive collector. For capture with no visible UI, load the collector on its own:

<script src="https://probie.dev/assets/probie-widget-events.js" data-token="YOUR_WIDGET_TOKEN"></script>

Client-rendered apps (React, Next.js, Vue) inject the same tag once on the client; there is no npm package for the web SDK. After load, attribute sessions to a signed-in user with window.probie('identify', userId) and to their company or team with window.probie('group', groupId). Pass null to either one to clear it, and call window.probie('reset') at logout to clear both. The ids are kept in sessionStorage next to the session id, so they last for the browser session and survive a reload.

Optionally, record the outcomes you care about. Automatic capture works without them; with them, Probie can tell which fixes moved a signup or a purchase:

window.probie('group', account.id);
window.probie('track', 'signup_completed', { plan: 'pro' });

Event names are 1 to 100 characters of letters, digits, spaces and _ . : / -. Props are a flat object with at most 25 keys, and each value is a string (up to 200 characters), a number, a boolean, or null. A numeric value prop is read as the outcome value, such as revenue or seats. Probie drops an event that breaks these rules. Track events are sampled with the session, so when data-sample is below 1, conversion counts are sampled too. Outcomes that happen on your server, such as a payment, are more reliable sent from there as server events.

Expo and React Native

The SDK targets the Expo managed workflow, SDK 50 and later, and has no runtime dependencies.

npx expo install @probie-dev/react-native

import { ProbieProvider } from '@probie-dev/react-native';

export default function RootLayout() {
  return (
    <ProbieProvider config={{ token: 'YOUR_WIDGET_TOKEN', apiBase: 'https://probie.dev' }}>
      {/* your app */}
    </ProbieProvider>
  );
}

The provider captures JavaScript errors, unhandled promise rejections, network failures, and app lifecycle on its own. Screens, taps, and form friction are opt-in hooks documented in the package README on npm.

Swift (macOS and iOS)

The Swift package supports macOS 12 and iOS 15 and later. Instrumentation is explicit; there is no method swizzling.

.package(url: "https://github.com/ProbieAI/probie-swift", from: "0.1.0")

import Probie

Probie.start(.init(token: "YOUR_WIDGET_TOKEN", apiBase: "https://probie.dev"))

Then mark what matters: .probieScreen("Checkout") and .probieTap("buy") on SwiftUI views, Probie.form("signup") for form friction, Probie.captureError(error) in catch blocks, and URLSession(configuration: Probie.instrumented(.default)) for failing requests.

Server events

Optional. Send outcomes such as signups, purchases and upgrades from your backend, where they actually happen. Send the events your app already records; you do not need to invent new ones.

Server events use a per-project secret key. Generate it in the Server events card on the Integration page. The key starts with pbs_ and is shown once, because Probie stores only a hash of it. Keep it on your server and never ship it to a browser or app. Rotating the key stops the old one immediately.

curl -X POST https://probie.dev/api/events \
  -H "Authorization: Bearer $PROBIE_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"events":[{"event":"subscription_started","user_id":"user_123","group_id":"acme","properties":{"plan":"pro","value":49}}]}'

From Node 18 or later, the @probie-dev/node package batches and retries for you:

import { Probie } from '@probie-dev/node';

const probie = new Probie({ secretKey: process.env.PROBIE_SECRET_KEY });
probie.track({ event: 'subscription_started', userId: user.id, groupId: org.id, properties: { plan: 'pro', value: 49 } });
await probie.shutdown(); // before the process exits

event

Required. Same rules as a browser event name.

user_id, group_id

At least one is required, up to 200 characters each. Use the same ids you pass to identify and group in the browser.

properties

Optional. Same rules as browser props; a numeric value is the outcome value.

timestamp

Optional. ISO-8601 or epoch milliseconds, from 30 days ago to 5 minutes ahead. Defaults to now.

event_id

Optional idempotency key, up to 128 characters. Probie ignores a repeat of the same id within an hour. The Node package always sends one.

A request carries at most 100 events and 256 KB. Probie answers 202 with the number received; 400 with the index and field of the first bad event, in which case nothing in the batch is stored; 401 for a missing or unknown key; 429 past the per-minute limit; and 503 when it cannot buffer events right now, which is safe to retry.

Install with a coding agent

The integration skill at https://probie.dev/skill is a SKILL.md file that walks a coding agent through registration and installation. The agent infers the project name, asks its human for an email and whether limited setup/product follow-up is allowed, provisions a token, installs it, verifies one passive event, and reports the emailed/browser claim flow. Point Claude Code, Cursor, or any agent that reads skills at it, or save it into the repository:

curl -fsSL https://probie.dev/skill -o .claude/skills/probie-integration/SKILL.md

The registration endpoint is POST /api/agent/registrations; it requires email, boolean contact_consent, and a high-entropy Idempotency-Key header. Omit project_name for inspection access, or include it to provision an integration. Every response includes a dispatch token and signed seven-day claim URL; integration responses also include widget and skill credentials. The MCP tools are split by task: register_inspection_access for inspecting only and register_integration for installing Probie.

HTTP API

Inspecting only: first register inspection access by omitting project_name. Installing Probie: include project_name in the same registration request. Keep the returned dispatch token secret.

curl -s -X POST https://probie.dev/api/agent/registrations \
  -H 'content-type: application/json' \
  -H 'Idempotency-Key: A_RETAINED_RANDOM_VALUE_AT_LEAST_32_CHARS' \
  -d '{"email":"[email protected]","contact_consent":false}'

Then start an inspection with the dispatch token as a bearer credential. The endpoint allows cross-origin requests.

curl -s -X POST https://probie.dev/api/dispatch \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer YOUR_DISPATCH_TOKEN' \
  -d '{"url": "example.com"}'

Add "signin_permission": true to let Probie sign in or create an account on the website during that one inspection. Send it only when the person you act for has agreed to it for that website. A signed-in inspection may open pages robots.txt asks crawlers to skip; it still avoids payments, publishing controls, and bot checks. The field must be a real boolean, and it defaults to false.

202

{"id": 123, "statusUrl": "...", "pageUrl": "..."}. A new inspection was queued.

200

The same fields plus "reused": true. The website already had a live inspection and you were attached to it.

400

{"error": "..."}. The body was not JSON, had no url, or named a private or reserved address.

401

{"error": "Unauthorized"}. The bearer token was missing, invalid, expired, or revoked.

429

{"error": "...", "retryAfterSecs": n} with a Retry-After header. The hourly limit was reached.

Poll statusUrl (GET /dispatch/{id}/status) every 5 seconds or so. The payload depends on the state:

queued or running

{"status", "progress", "queuedAhead", "activity": [...], "chips": {...}}. activity is a short plain-language log.

ok

{"status": "ok", "reportUrl": "/report/<id>/<slug>"}. The report is ready.

error or skipped

{"status", "failureMessage", "allowUrl"}. skipped means a bot wall stopped Probie; allowUrl explains how to let it through.

MCP server

The same surface is available to agents as a remote MCP server at https://probie.dev/mcp. It uses Streamable HTTP. Registration and status reads are public; starting an inspection requires the dispatch token returned by registration. Add it to a client:

{
  "mcpServers": {
    "probie": { "type": "http", "url": "https://probie.dev/mcp" }
  }
}

claude mcp add --transport http probie https://probie.dev/mcp

register_inspection_access

Inspecting only: register an email-bound dispatch identity without creating a project.

register_integration

Provision a widget token after collecting the human’s email and consent choice. Requires a retained idempotency key and returns a seven-day claim URL.

inspect_website

Start an inspection with a dispatch token. Returns the id and the URLs to poll and open; reuses live and recent inspections.

get_inspection

The state of an inspection by id, with absolute report and allow URLs when it has finished.

get_integration_skill

The integration skill, with the token filled in when a widget token is passed.

probie://skill

The generic integration skill as a text/markdown resource.

Usage limits apply to inspection and registration across both REST and MCP. A rate-limited response tells the caller when to retry.