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.

Navigation

• Getting Started
• Openclaw Integration
• API Reference

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

This repository is designed for GitBook import and static publishing.