Inboxlayer Documentation

Inboxlayer is a mailbox operations API for developers and automation agents that need deterministic email workflows.

This documentation is written for both two audiences:

Developers integrating APIs into services, automations, and infrastructure.
Agent builders creating reliable, long-running mailbox workflows.

What you will find

Orientation and setup for first successful integrations.
Depth on agentic use cases and why programmatic email is required for many workflows.
Feature and implementation patterns for accounts, inboxes, emails, drafts, labels, streams, webhooks, and domains.
Real-time event handling using streams and webhooks.
OpenAPI source of truth and endpoint/schemas.
SDK release placeholders while SDK packages are published.

OpenAPI source of truth

The contract file is:

openapi/api-v1.json

This file is synchronized from the Rails app contract and is the single source for shape, validation, and error behavior.

To refresh from source:

./scripts/sync-openapi.sh

SDK status

The SDK pages are placeholders while client packages are being published:

Ruby SDK (placeholder link)
Python SDK (placeholder link)

Until SDKs ship, the API contract and direct HTTP calls are the integration baseline.

Hosting

Live site: https://docs.inboxlayer.dev

The docs are hosted on Vercel as a static site. The _book/ directory contains the pre-built GitBook output and is deployed directly.

Project structure

├── README.md              # This file
├── SUMMARY.md             # GitBook table of contents
├── book.json              # GitBook config
├── vercel.json            # Vercel deployment config
├── _book/                 # Built static site (deployed to Vercel)
├── api/                   # API reference markdown
├── features/              # Feature documentation markdown
├── getting-started/       # Onboarding guides markdown
├── guides/                # Implementation guides markdown
├── integrations/          # Integration docs markdown
├── openapi/               # OpenAPI contract (api-v1.json)
├── scripts/               # Utility scripts (sync-openapi.sh)
└── sdks/                  # SDK documentation markdown

Deploying

The site is deployed from the _book/ directory. Vercel is not connected to GitHub for auto-deploy, so deploys are manual.

To redeploy after making changes:

# 1. Rebuild the GitBook output (requires gitbook-cli)
gitbook build

# 2. Deploy to Vercel production
cd _book && vercel deploy --prod

Vercel project details

Project name: inboxlayer-docs
Team: ivorpads-projects
Output directory: _book/ (deployed directly, no build step on Vercel)
Framework: None (static files)

Custom domain

Domain: docs.inboxlayer.dev
DNS: CNAME record on Cloudflare pointing docs to cname.vercel-dns.com (proxy disabled)
SSL: Managed by Vercel

GitHub repository

https://github.com/ivorpad/inboxlayer-docs.git

Introduction