Freightbox developer platform

Choose the interface that fits the job

Freightbox webhooks

Programmatic inboxes can register a webhook URL and receive signed deliveries for inbound messages, so your application reacts to new mail without polling. Delivery logs are queryable through the Platform Email API with the platform:inbox:read scope. Endpoints, payloads, and signature verification are specified in the OpenAPI 3.1 specification and the interactive API reference.

Authentication

Every production interface authenticates with an API key that a human organization administrator provisions and scopes. The full flow — key creation, header format, scope families, and inbox restrictions — is documented in the Freightbox authentication guide.

Start with the narrowest credential

Skip this section for the public documentation MCP: it needs no credential. For the Platform API or action MCP, follow the least-privilege flow below.

1. 1. Ask a human organization administrator to create the key. API keys are created in Freightbox API Key settings. The plaintext secret is displayed once.
2. 2. Restrict its scopes and inboxes. Set only the permissions the integration needs and, when possible, allowlist the exact inbox IDs it may access.
3. 3. Send it only in the authorization header. Never put a key in a URL, browser bundle, public repository, prompt, or log.

Authorization: Bearer fb_live_...

Freightbox does not support OAuth or autonomous agent registration today. A human organization administrator provisions and revokes each API key. Clients must not invent an OAuth flow or request credentials from public endpoints.

Scope model

REST and the action MCP have separate scope families. Omitted scopes preserve unrestricted legacy behavior, so new integrations should always choose an explicit list.

Platform Email API scopes

platform:inbox:read

List inboxes, messages, and webhook delivery logs.

platform:inbox:write

Create, update, or delete programmatic inboxes.

platform:identity:read

List and inspect sending identities.

platform:identity:write

Create, update, or delete sending identities.

platform:message:send

Send email from an authorized platform identity.

MCP inbox scopes

inbox:read

Read threads, contacts, companies, mailboxes, and analytics.

inbox:write

Mark threads read and update contact or company records.

inbox:send

Reply to threads and send new email.

Treat an inbox:send key like SMTP credentials. For an agent reading untrusted inbound email, prefer a read-only key so prompt content cannot be turned into an outbound-send capability.

Verify the REST connection

The recommended versioned route is /api/v1. This read call lists only inboxes allowed by the key.

curl https://api.getfreightbox.com/api/v1/platform/inboxes \
  -H "Authorization: Bearer $FREIGHTBOX_API_KEY"

Outbound sends support Idempotency-Key for safe retries. Respect 429 responses and their rate-limit headers.