Wachete plugin

• Two-step auth. POST /thirdparty/v1/user/apilogin exchanges { userId, apiKey } for a token, and every other call sends Authorization: bearer <token> — the word bearer lowercased, as Wachete’s own docs write it. The plugin accepts a packed <userId>\n<apiKey> key and does the login itself, caching the token until it expires, or a bare token if you already have one.
• Creating and updating are one call, but the two use different methods. tasks.upsert is a PUT on the collection and folders.upsert is a POST on the same collection; in both, the body’s id decides between creating and updating, not the route.
• The enums are ambiguous, and the plugin accepts both forms. Wachete’s OpenAPI document declares alert, job and messaging types as integers, but that same document’s own example payload sends names ("Error", "NotEq", "Webhook", "SinglePage") and the prose docs do too. The plugin accepts a name or the number and sends what you give it, so either contract works.
• Alert names. Error, Changed, NotEq, Eq, Contains, NotContains, StartsWith, EndsWith, Regex, Lower, Greater, Exists, NotExists. Messaging names: Email, Webhook, Sms, Slack, Teams, Telegram, Pushover, Discord.
• A SinglePage monitor takes no crawling settings. crawlingDepth, urlFilter, crawlBinaryContent and crawlPagesFromAllDomains only apply to a Portal monitor, so sending them on a SinglePage one is rejected before the request rather than silently ignored.
• tasks.search sits after /task/{id} in the API’s path table. A router that matched {id} first would treat “search” as a monitor id; Wachete’s own routing resolves it, and the plugin calls /task/search explicitly.
• Deleting a folder deletes its contents. folders.delete removes every subfolder and monitor inside it, which makes it the most destructive call here — far more than tasks.delete, which removes one monitor.
• The last value lives in data. A monitor’s data.raw is what the last check read, data.valueChangedTimestamp is when it last differed, and data.error is set when the check failed — so a monitor can be failedCount without any notification arriving.
• History and notifications page by continuation token. Both answer continuationToken, which is null on the last page. data.list can return a Google-style diff per entry with returnDiff, which is much larger than the raw values.
• notifications.get carries the sent HTML. It answers JSON with the monitor’s name, url, timestampUtc and the alert as the html that was sent. The plugin’s event log records the HTML’s length, never its content, which is the watched page’s text.

• 12 typed API operations

​

Setup

npm install corsair @corsair-dev/wachete better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/wachete better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/wachete better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/wachete better-sqlite3
bun add --dev @types/better-sqlite3

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { wachete } from '@corsair-dev/wachete';

export const corsair = createCorsair({
	plugins: [
		wachete(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});

wachete()

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'wachete',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

​

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.wachete.api.tasks.get({ id: '9f7e1ae7-9a7f-49e0-baa2-ffd8760f7b9e' });

const tenant = corsair.withTenant('acme');
await tenant.wachete.api.tasks.upsert({
	name: 'My First Monitor',
	url: 'http://www.mypage.com',
	xPath: '/',
	recurrenceInSeconds: 86400,
});

​

What’s next