Fivexer TypeScript SDK

The TypeScript SDK (@fivexer/sdk) is the reference implementation for the /v1 API. It has zero runtime dependencies and runs anywhere with fetch.

Install

bash
npm install @fivexer/sdk

Quickstart

typescript
import { Fivexer } from '@fivexer/sdk';

const client = new Fivexer({
    baseUrl: 'https://api.fivexer.com',
    apiKey: 'sk_test_...',
});

await client.workers.upsert({ id: 'agent_1', tags: ['english', 'billing'] });
const task = await client.tasks.create({ tags: ['english', 'billing'], priority: 90 });
console.log(task.id, task.status);

Errors and quotas

typescript
import { FivexerApiError } from '@fivexer/sdk';

try {
    await client.tasks.create({ tags: ['english'] });
} catch (e) {
    if (e instanceof FivexerApiError) {
        console.log(e.status, e.code);
        console.log(e.quota?.taskRateRemaining);
    }
}

Worker portal

The worker client is flat — session, queue, and task actions are all methods on the client itself:

typescript
import { FivexerWorker } from '@fivexer/sdk';

const worker = new FivexerWorker({ baseUrl: 'https://api.fivexer.com' });
await worker.login({ workspaceId: 'ws_1', workerId: 'agent_1', pin: '4821' });

const queue = await worker.queue();
await worker.accept(queue.taskIds[0]);
await worker.complete(queue.taskIds[0], { outcome: 'resolved' });

Breaks, availability, skills, and metrics live on the same client (worker.startBreak(), worker.setAvailability(false), worker.setSkills([...]), worker.metricsToday()), with worker.comments, worker.devices, and worker.push grouped as namespaces.

For React Native, @fivexer/expo wraps this client with SecureStore session persistence, a live queue WebSocket, and hooks.

Supervisor

FivexerSupervisor is the crew-lead plane. Unlike the worker client, its actions are grouped:

typescript
import { FivexerSupervisor } from '@fivexer/sdk';

const sv = new FivexerSupervisor({ baseUrl: 'https://api.fivexer.com' });
await sv.acceptInvite({ token: tokenFromLink });

const board = await sv.overview();
await sv.tasks.assign(board.parked[0].id, board.crew[0].workerId);

See the supervisor plane for the full surface.

Webhooks

Webhook verification is Node-only and lives at the @fivexer/sdk/webhook subpath so browser bundles don't pull node:crypto:

typescript
import { verifyWebhookSignature, SIGNATURE_HEADER } from '@fivexer/sdk/webhook';

const ok = verifyWebhookSignature(secret, header, await request.text());