vercel webhooks

The vercel webhooks command is used to manage webhooks for your Vercel account, providing functionality to list, inspect, create, and remove webhooks. Webhooks allow you to receive HTTP POST requests when events occur in your Vercel account.

For more information about webhooks and their supported events, see the Webhooks documentation.

The vercel webhooks command supports the following subcommands:

• list - List all webhooks
• get - Get details of a specific webhook
• create - Create a new webhook
• rm - Remove a webhook

The vercel webhooks list command lists all webhooks configured for your account.

vercel webhooks list

You can also use the ls alias:

vercel webhooks ls

Use the --format option to output the list as JSON:

vercel webhooks ls --format json

The vercel webhooks get command displays detailed information about a specific webhook.

vercel webhooks get <id>

You can also use the inspect alias:

vercel webhooks inspect <id>

Use the --format option to output the webhook details as JSON:

vercel webhooks get <id> --format json

The vercel webhooks create command creates a new webhook for your account.

vercel webhooks create <url> --event <event>

You can also use the add alias:

vercel webhooks add <url> --event <event>

At least one event is required when creating a webhook. Use the --event option (shorthand -e) to specify which events the webhook should listen for. You can specify multiple events by using the option multiple times:

vercel webhooks create https://example.com/webhook --event deployment.created --event deployment.ready

By default, webhooks listen to events from all projects in your account. Use the --project option (shorthand -p) to limit the webhook to specific projects. You must provide the project ID (for example, prj_abc123), not the project name. To find a project ID, open the project in the Vercel dashboard, go to Settings → General, or run vercel project ls in the CLI.

vercel webhooks create https://example.com/webhook --event deployment.created --project prj_abc123

You can specify multiple projects:

vercel webhooks create https://example.com/webhook --event deployment.created --project prj_abc123 --project prj_def456

The vercel webhooks rm command removes a webhook from your account.

vercel webhooks rm <id>

You can also use the remove or delete aliases:

vercel webhooks remove <id>
vercel webhooks delete <id>

By default, the command prompts for confirmation before removing the webhook. Use the --yes option to skip the confirmation:

vercel webhooks rm <id> --yes

These are options that only apply to the vercel webhooks command.

The --format option can be used with the list and get subcommands to output results as JSON. The only supported value is json.

vercel webhooks ls --format json

The --event option (shorthand -e) specifies which events the webhook should listen for when using the create subcommand. This option can be used multiple times to subscribe to multiple events.

vercel webhooks create https://example.com/webhook --event deployment.created

See the supported event types for a complete list of available events.

The --project option (shorthand -p) limits the webhook to specific projects when using the create subcommand. Provide the project ID (for example, prj_abc123). You can find it in the project's Settings → General in the dashboard, or by running vercel project ls. This option can be used multiple times to include multiple projects.

vercel webhooks create https://example.com/webhook --event deployment.created --project prj_abc123

The --yes option can be used with the rm subcommand to skip the confirmation prompt when removing a webhook.

vercel webhooks rm <id> --yes

The following global options can be passed when using the vercel webhooks command:

• --cwd
• --debug
• --global-config
• --help
• --local-config
• --no-color
• --scope
• --token

For more information on global options and their usage, refer to the options section.

• Setting up webhooks
• Webhooks API reference