Developer API & Webhooks

// Playwright / Vitest E2E OTP Authentication Example
const API = 'http://localhost:3000/api/v1';
const headers = {
  Authorization: 'Bearer flx_live_YOUR_API_KEY',
  'Content-Type': 'application/json',
};

// 1. Provision an instant disposable inbox
const { inbox } = await fetch(`${API}/inboxes`, {
  method: 'POST',
  headers,
  body: JSON.stringify({ ttlMinutes: 30 }),
}).then((r) => r.json());

// 2. Trigger sign-up in your application under test using inbox.address
await page.fill('input[name="email"]', inbox.address);
await page.click('button[type="submit"]');

// 3. Long-poll /wait — resolves within milliseconds of SMTP arrival!
const { message } = await fetch(
  `${API}/inboxes/${inbox.id}/wait?timeoutMs=15000`,
  { headers }
).then((r) => r.json());

console.log('Extracted OTP:', message.extractedOtp);
await page.fill('input[name="otp"]', message.extractedOtp);

REST API v1 Endpoints