​
Installation

Install the Inbound SDK using your preferred package manager: 
npm install @inboundemail/sdk

​
Requirements

  • Node.js 18.0 or later
  • TypeScript 4.5+ (for TypeScript projects)

​
Quick Start

1

Import the SDK

import { Inbound } from '@inboundemail/sdk'
2

Initialize with your API key

const inbound = new Inbound({
  apiKey: process.env.INBOUND_API_KEY
})
3

Make your first API call

const domains = await inbound.domains.list()
console.log(`You have ${domains.data.length} domains`)

​
TypeScript Support

The SDK includes comprehensive TypeScript definitions. All request and response types are fully typed for excellent IDE support and type safety. 
import type { 
  InboundWebhookPayload,
  InboundWebhookEmail,
  Webhook
} from '@inboundemail/sdk'

​
Next Steps

Configuration

Learn about SDK configuration options

Webhook Handling

Handle incoming email webhooks

Examples

See complete implementation examples

API Reference

Explore the full API reference