Skip to main content

Routes Command

Manage inbound email routes for processing incoming messages through webhooks.

Overview

Available subcommands:
  • list - List all inbound email routes
  • create - Create a new inbound email route
  • get - Get detailed information about a specific route
  • update - Update an existing inbound email route
  • delete - Delete an inbound email route
  • listen - Listen for inbound email events in real-time
  • trigger - Trigger route events for testing
Routes enable you to:
  • Process inbound emails through webhooks
  • Filter emails by recipient patterns
  • Control attachment handling and formatting
  • Group messages by conversation threads
  • Strip reply content for cleaner processing

List Routes

Create Route

Get Route Details

Update Route

Delete Route

Listen for Events (Development)

Listen for inbound email routing events in real-time using WebSocket connection. This command establishes a WebSocket connection to receive inbound email events and can forward them to a local endpoint for development.

Listen Flags

  • Attachment data is not sent over WebSocket for performance reasons. Only email metadata and content are transmitted.
  • The command generates a webhook secret for signing forwarded events using the standard-webhooks specification.
  • The command handles disconnections with buffered event replay.

Trigger Test Events (Development)

Manually trigger route events for testing:
This is a development-only feature and may not be available in production environments.

Next Steps