Quick Start Guide

ZeroFlake bridges the gap between unstructured emails and your codebase. Learn how to provision inboxes, extract data, and receive real-time webhooks.

The Webhook Payload

When an email is sent to your ZeroFlake inbox, we instantly parse the content, extract key data (like OTPs or links), and `POST` a structured JSON payload to your destination URL.

Zero polling required. Data arrives instantly.
Secure parsing. We handle the messy MIME types and HTML stripping.

Example POST payload sent to your server

{
  "event": "email.received",
  "data": {
    "inbox_id": "inb_8x92nd",
    "email_address": "test-992@inbox.zeroflake.dev",
    "sender": "noreply@stripe.com",
    "subject": "Your verification code",
    "extracted_payload": {
      "payload": { "otp_code": "819234" }
    },
    "received_at": "2026-03-08T14:53:00Z"
  }
}

Popular Use Cases

1. E2E Auth Testing

Use Playwright or Cypress to trigger a "Forgot Password" flow. Have your test suite listen for the ZeroFlake webhook, extract the code, and instantly input it to complete the test.

2. The "Shadow API"

Working with a vendor that only sends PDF invoices or email confirmations? Route them to ZeroFlake to instantly convert those emails into database triggers.

3. Lead Routing

Point third-party directory sites (like Zillow or Yelp) to a ZeroFlake inbox. We catch the lead email, parse the contact info, and push it directly into your CRM.

REST API Guide

Prefer pulling data or need to provision inboxes dynamically from your codebase? Our REST API allows you to manage everything programmatically.

Authentication: Pass your Secret API Key (found in your dashboard) as a Bearer token in the Authorization header.

POST/api/v1/inboxes

curl -X POST https://api.zeroflake.dev/v1/inboxes \
  -H "Authorization: Bearer zf_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "webhook_url": "https://myapp.com/webhooks"
  }'