Command
nylas webhook triggers
The nylas webhook triggers command displays every event type you can subscribe a webhook to — message.created, event.updated, contact.deleted, and more. Use --json for pipe-friendly output. Useful when configuring or updating webhook subscriptions.
Written by Qasim Muhammad Staff SRE
What does nylas webhook triggers do?
The nylas webhook triggers command displays every event type you can subscribe a webhook to — message.created, event.updated, contact.deleted, and more. Use --json for pipe-friendly output. Useful when configuring or updating webhook subscriptions.
Usage
nylas webhook triggers [--category CATEGORY] [--json]Flags
| Flag | Description |
|---|---|
| --json | Output as JSON |
| --no-color | Disable color output |
| --verbose(-v) | Enable verbose output |
| --config | Custom config file path |
| --help(-h) | Show help for the command |
| --limit | Limit results (most list commands) |
| --yes(-y) | Skip confirmations |
| --category(-c) | Filter by trigger category |
Examples
List all trigger types
nylas webhook triggersList message trigger types
nylas webhook triggers --category message --jsonFilter for email triggers
nylas webhook triggers --json | jq '.[] | select(startswith("message."))'Troubleshooting
Empty trigger list
Ensure you have a valid API key configured. Run nylas auth config to verify.
Trigger type not recognized when creating webhook
Copy the exact trigger string from this list. Trigger names are case-sensitive (e.g. message.created, not Message.Created).
Recommended guides
Send OTP and 2FA Codes by Email
Generate a cryptographically secure one-time code and send it by email from the terminal — no SMTP. Test the full round trip and learn email OTP's limits.
How to Evaluate an Email AI Agent
Evaluate an email agent with a labeled test set, classification and action-accuracy metrics, and prompt-injection guardrail tests you run on every change.
Gmail API Sandbox: Test Email Integrations
Gmail has no API sandbox. Compare the real options: a dedicated test account, the Amazon SES sandbox, fake SMTP inboxes, and nylas demo with sample data.
Password Reset Emails: Choosing an API
Password reset emails are latency-critical transactional sends. Compare SES, Postmark, SendGrid, and Nylas, meet Gmail's sender rules, and test the loop.
Mailtrap Alternative for Real Inbox Testing
Compare Mailtrap, Mailosaur, and Nylas Agent Accounts for testing transactional email flows with real inbox delivery.
Cypress Email Testing
Test password resets, magic links, and OTP emails in Cypress with a real inbox, Nylas CLI JSON output, and isolated agent accounts.
Test Email Webhooks Locally
Test Nylas email webhooks locally with tunnel setup, signed payload checks, trigger discovery, and replayable fixtures before shipping handlers.
Extract OTP Codes from Email — Skip the Inbox
Pull 2FA verification codes from email without opening your inbox. The nylas otp get command copies the latest code to your clipboard across all providers.
CI/CD Email Alerts with PowerShell
Send build failure alerts, deployment reports, and test results from GitHub Actions, Azure DevOps, and Jenkins pipelines using PowerShell and Nylas CLI.
E2E Email Testing with Playwright
Test password reset, invitation, and verification emails end-to-end. Poll with Nylas CLI, verify content in Playwright, and click links. No Gmail config needed.
Run nylas webhook triggers --help for full help output.