Webhooks fire when email arrives, events change, or contacts update. nylas webhook server helps you start a local webhook server for development.
The nylas webhook server command starts a local HTTP server that receives webhook events from Nylas. It automatically creates a tunnel so Nylas can reach your machine.
Quick Start
brew install nylas/nylas-cli/nylas
nylas init
nylas webhook server
When to use this command
Webhooks deliver real-time notifications when events happen (new email, calendar change). Use the CLI to create, test, and debug webhooks without a web dashboard.
Examples
Start on default port:
nylas webhook server
Start on a custom port:
nylas webhook server --port 8080
How It Works
Webhooks replace polling. Instead of checking every 30 seconds whether new email arrived, the webhook pushes the event to your endpoint within seconds. This reduces API calls and improves latency for your application.
Syntax
nylas webhook server [--port PORT]
Related Commands
-
nylas webhook list— List all webhooks -
nylas webhook create— Create a webhook for real-time event notifications -
nylas webhook delete— Delete an existing webhook by ID -
nylas webhook test send— Send a test webhook event to a URL
Related posts
Full docs: nylas webhook server reference — all flags, advanced examples, and troubleshooting.
All commands: Nylas CLI Command Reference
Get started: brew install nylas/nylas-cli/nylas — other install methods
Top comments (0)