> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://learning.postman.com/llms.txt. # Webhook commands This topic covers webhook commands for the [Postman CLI](/docs/postman-cli/postman-cli-overview/). You can use the `postman webhook` commands to create, list, delete, and manage webhooks in a workspace directly from the CLI. You can check the status of a webhook and start or pause it as needed. You can also forward events received on a webhook to your local server to aid development and debugging, as well as list, inspect, and replay the requests a webhook has received. In each of these operations, you have the choice to pass either the Webhook URL, which is available by clicking Copy icon **Webhook URL** on your Webhooks tab, or the Webhook ID, which is available by clicking the Info icon **Webhook details** button on the right sidebar. For more information about webhooks in Postman, see [Webhooks](/docs/use/send-requests/protocols/webhooks). You can find the webhook ID using the [`postman webhook list` command](#postman-webhook-list) or [`postman webhook status` command](#postman-webhook-status). ## `postman webhook create` This command creates a new webhook in the specified workspace. Add the command to your CI/CD script or agent workflow to automate webhook provisioning. To use this command, sign in to Postman with [the `postman login` command](/docs/postman-cli/postman-cli-auth/#postman-login). ### Usage ```bash postman webhook create [options] ``` ### Options **`--name `** The name of the webhook. --- **`--workspace `** The ID of the workspace in which to create the webhook. --- ### Example ```bash postman webhook create --name my-webhook --workspace f41rq7g4czitvik2ovypnir ``` ## `postman webhook list` This command lists all webhooks in the specified workspace, along with their IDs and current status. To use this command, sign in to Postman with [the `postman login` command](/docs/postman-cli/postman-cli-auth/#postman-login). ### Usage ```bash postman webhook list [options] ``` ### Options **`--workspace `** The ID of the workspace whose webhooks you want to list. --- ### Example ```bash postman webhook list --workspace f41rq7g4czitvik2ovypnir ``` ## `postman webhook delete` This command permanently deletes a webhook by its ID. This action can't be undone. To use this command, sign in to Postman with [the `postman login` command](/docs/postman-cli/postman-cli-auth/#postman-login). ### Usage ```bash postman webhook delete [options] ``` **``** The unique identifier of the webhook to delete. --- ```bash postman webhook delete [options] ``` **``** The unique URL of the webhook to delete. --- ### Options **`-w, --workspace `** The ID of the Postman workspace containing the webhook. --- **`--api-key `** Your Postman API key. --- ### Example ```bash postman webhook delete 1f41rq7g4czitvik2ovypnir ``` ## `postman webhook status` This command shows details for a webhook, including its title, current status (active or inactive), invoke URL, and creation date. To use this command, sign in to Postman with [the `postman login` command](/docs/postman-cli/postman-cli-auth/#postman-login). ### Usage ```bash postman webhook status [options] ``` **``** The unique identifier of the webhook. --- ```bash postman webhook status [options] ``` **``** The unique URL of the webhook. --- ### Options **`-w, --workspace `** The ID of the Postman workspace containing the webhook. --- **`--api-key `** Your Postman API key. --- ### Example ```bash postman webhook status f41rq7g4czitvik2ovypnir ``` ## `postman webhook start` This command starts a paused or inactive webhook, enabling it to begin receiving events. To use this command, sign in to Postman with [the `postman login` command](/docs/postman-cli/postman-cli-auth/#postman-login). ### Usage ```bash postman webhook start ``` **``** The unique identifier of the webhook to start. --- ```bash postman webhook start ``` **``** The unique URL of the webhook to start. --- ### Example ```bash postman webhook start f41rq7g4czitvik2ovypnir ``` ## `postman webhook pause` This command pauses an active webhook, stopping it from receiving events. You can resume it at any time using [`postman webhook start`](#postman-webhook-start). To use this command, sign in to Postman with [the `postman login` command](/docs/postman-cli/postman-cli-auth/#postman-login). ### Usage ```bash postman webhook pause ``` **``** The unique identifier of the webhook to pause. --- ```bash postman webhook pause ``` **``** The unique URL of the webhook to pause. --- ### Example ```bash postman webhook pause f41rq7g4czitvik2ovypnir ``` ## `postman webhook forward` This command forwards events received on a webhook from external services (such as Stripe or Slack) to a port on your local server. This is useful for developing and debugging webhook handlers without exposing a public endpoint. The command listens for incoming events on the specified webhook and relays them to your local server at the given port. The forwarding runs until you stop it by pressing **Control+C** or **Ctrl+C**. To use this command, sign in to Postman with [the `postman login` command](/docs/postman-cli/postman-cli-auth/#postman-login). ### Usage ```bash postman webhook forward ``` **``** The unique identifier of the webhook whose events you want to forward. --- **``** The local port number to forward events to. --- ```bash postman webhook forward ``` **``** The unique URL of the webhook whose events you want to forward. --- **``** The local port number to forward events to. --- ### Example ```bash postman webhook f41rq7g4czitvik2ovypnir forward 3000 ``` ## `postman webhook requests` These commands enable you to list, inspect, and replay the requests a webhook has received. In each command, you can pass either the webhook ID or the webhook URL. To use these commands, sign in to Postman with [the `postman login` command](/docs/postman-cli/postman-cli-auth/#postman-login). ### `postman webhook requests list` This command lists the recent requests a webhook has received, along with each request's ID, event type, method, path, response status, and the time it was received. Use a request ID from this list with the [`postman webhook requests describe`](#postman-webhook-requests-describe) and [`postman webhook requests replay`](#postman-webhook-requests-replay) commands. #### Usage ```bash postman webhook requests list [options] ``` **``** The unique identifier of the webhook. --- ```bash postman webhook requests list [options] ``` **``** The unique URL of the webhook. --- #### Options **`-w, --workspace `** The ID of the Postman workspace containing the webhook. If omitted, the CLI uses the workspace from your local Postman configuration. --- **`--cursor `** Cursor value for paginating through results. The command returns up to 20 requests per page. When more are available, it prints a `Next cursor` value that you can pass to `--cursor` to fetch the next page. --- **`--api-key `** Your Postman API key. --- #### Example ```bash postman webhook requests list f41rq7g4czitvik2ovypnir ``` ### `postman webhook requests describe` This command shows the full details for a single request a webhook received, including its headers, body, and any recorded responses. Use [`postman webhook requests list`](#postman-webhook-requests-list) to find the request ID. #### Usage ```bash postman webhook requests describe [options] ``` **``** The unique identifier of the webhook. --- **``** The unique identifier of the request to describe. --- ```bash postman webhook requests describe [options] ``` **``** The unique URL of the webhook. --- **``** The unique identifier of the request to describe. --- #### Options **`-w, --workspace `** The ID of the Postman workspace containing the webhook. If omitted, the CLI uses the workspace from your local Postman configuration. --- **`--api-key `** Your Postman API key. --- #### Example ```bash postman webhook requests describe f41rq7g4czitvik2ovypnir 11111111-1111-4111-8111-111111111111 ``` ### `postman webhook requests replay` This command replays a request a webhook received. Postman forwards or responds to the request through the routing rule configured for the webhook. Use [`postman webhook requests list`](#postman-webhook-requests-list) to find the request ID. #### Usage ```bash postman webhook requests replay [options] ``` **``** The unique identifier of the webhook. --- **``** The unique identifier of the request to replay. --- ```bash postman webhook requests replay [options] ``` **``** The unique URL of the webhook. --- **``** The unique identifier of the request to replay. --- #### Options **`-w, --workspace `** The ID of the Postman workspace containing the webhook. If omitted, the CLI uses the workspace from your local Postman configuration. --- **`--api-key `** Your Postman API key. --- #### Example ```bash postman webhook requests replay f41rq7g4czitvik2ovypnir 11111111-1111-4111-8111-111111111111 ```