Command

nylas webhook test send

The nylas webhook test send-URL command fires a simulated webhook event to any URL you specify. Choose the trigger type with --trigger (e.g. message.created, event.created). Use it to verify your endpoint handles payloads correctly before going live.

Usage

nylas webhook test send-URL --url URL --trigger TRIGGER

Flags

FlagDescription
--jsonOutput as JSON
--no-colorDisable color output
--verbose(-v)Enable verbose output
--configCustom config file path
--help(-h)Show help for the command
--limitLimit results (most list commands)
--yes(-y)Skip confirmations
--urlDestination URL to send the test event to
--triggerTrigger type (e.g. message.created, event.created)

Examples

Test with an email trigger

nylas webhook test send-URL --url https://example.com/webhook --trigger message.created

Test with a calendar trigger

nylas webhook test send-URL --url http://localhost:4567/webhook --trigger event.created

Troubleshooting

Connection refused

Verify the URL is reachable. For localhost URLs, ensure your server is running on the correct port.

Unknown trigger type

Run nylas webhook triggers to see all available trigger types.

Recommended guides

Run nylas webhook test send --help for full help output.