Routes Command
Manage inbound email routes for processing incoming messages through webhooks.Overview
list
- List all inbound email routescreate
- Create a new inbound email routeget
- Get detailed information about a specific routeupdate
- Update an existing inbound email routedelete
- Delete an inbound email routelisten
- Listen for inbound email events in real-timetrigger
- Trigger route events for testing
- 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
Flag | Description |
---|---|
--route-id | Use existing route instead of creating temporary one |
--recipient | Recipient pattern for temporary route (e.g., *@domain.com) |
--forward-to | Local endpoint to forward events to |
--slim-output | Slim down the payload for printing to the console |
--skip-verify | Skip SSL certificate verification for local endpoints |
- 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.