Documentation

CLI Commands

Reference for login, list, and proxy commands.

`payloadr login`

Authenticate with your API key.

payloadr login

Options:

-k, --key <key>  Provide API key directly

Examples:

payloadr login
payloadr login --key pk_live_abc123...

`payloadr list`

List all your available webhook endpoints.

payloadr list

`payloadr proxy`

Start the webhook proxy for a specific endpoint.

payloadr proxy <endpoint-slug>

Arguments:

<endpoint-slug>  The slug of the endpoint to proxy

Options:

-p, --port <port>  Local port (default: 3000)
--path <path>      Path on local server (default: /webhooks)
-u, --url <url>    Full URL to forward to
--replay           Replay recent webhooks on startup

Examples:

payloadr proxy payment-webhooks
payloadr proxy payment-webhooks --port 8080 --path /api/webhooks
payloadr proxy payment-webhooks --url http://localhost:3000/api/payments
payloadr proxy payment-webhooks --replay