Skip to content

Commit 98d5c40

Browse files
authored
Merge pull request #164 from hookdeck/chore/listen-cmd-update
chore(docs): update listen command flags and descriptions in README
2 parents 50c6dc3 + 244778d commit 98d5c40

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,16 @@ hookdeck login --interactive
112112
Start a session to forward your events to an HTTP server.
113113

114114
```sh
115-
hookdeck listen <port-or-URL> <source-alias?> <connection-query?> [--path?] [--output?]
115+
hookdeck listen <port-or-URL> <source-alias?> <connection-query?> [flags]
116+
117+
Flags:
118+
--path string Sets the path to which events are forwarded (e.g., /webhooks or /api/stripe)
119+
--output string Output mode: interactive (full UI), compact (simple logs), quiet (only fatal errors) (default "interactive")
120+
--max-connections int Maximum concurrent connections to local endpoint (default: 50, increase for high-volume testing)
121+
--filter-body string Filter events by request body using Hookdeck filter syntax (JSON)
122+
--filter-headers string Filter events by request headers using Hookdeck filter syntax (JSON)
123+
--filter-query string Filter events by query parameters using Hookdeck filter syntax (JSON)
124+
--filter-path string Filter events by request path using Hookdeck filter syntax (JSON)
116125
```
117126

118127
Hookdeck works by routing events received for a given `source` (i.e., Shopify, Github, etc.) to its defined `destination` by connecting them with a `connection` to a `destination`. The CLI allows you to receive events for any given connection and forward them to your localhost at the specified port or any valid URL.

0 commit comments

Comments
 (0)