Command

nylas webhook update

Update an existing webhook's URL or triggers.

Written by Qasim Muhammad Staff SRE

What does nylas webhook update do?

The nylas webhook update command modifies a webhook destination. Change the delivery URL with --url, or add and remove trigger types with --triggers. Pass the webhook ID as a positional argument. Changes take effect immediately — the next event fires to the updated URL.

Usage

nylas webhook update <webhook-id> [--url URL] [--triggers TRIGGERS]

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
--urlNew destination URL
--triggersComma-separated trigger types to subscribe to
--description(-d)New description
--notify(-n)New notification email addresses
--status(-s)New status (active or inactive)

Examples

The nylas webhook update command modifies a webhook destination.

Change the webhook URL

nylas webhook update wh_abc123def456 --url https://new-endpoint.example.com/webhook

Add a trigger type

nylas webhook update wh_abc123def456 --triggers message.created,event.created,event.updated

Example output

✓ Webhook updated (webhook_abc123)
  URL:      https://example.com/webhooks
  Triggers: message.created, message.updated
  Status:   inactive

Troubleshooting

Webhook not found

Run nylas webhook list to confirm the webhook ID. It may have been deleted.

Invalid trigger type

Run nylas webhook triggers to see valid types. Trigger names are case-sensitive.

Recommended guides

Run nylas webhook update --help for full help output.