Skip to content

Commit 72238a1

Browse files
authored
Merge pull request #152 from hookdeck/chore/connection-query-docs
docs: clarify connection-query parameter usage in CLI
2 parents e8e4138 + 0db5a39 commit 72238a1

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ twilio -> cli-twilio forwarding to /webhooks/twilio
167167

168168
#### Listen to a subset of connections
169169

170-
The 3rd param, `connection-query` can be used to filter the list of connections the CLI will listen to. The connection query can either be the `connection` `alias` or the `path`
170+
The 3rd param, `connection-query` specifies which connection with a CLI destination to adopt for listening. By default, the first connection with a CLI destination type will be used. If a connection with the specified name doesn't exist, a new connection will be created with the passed value. The connection query is checked against the `connection` name, `alias`, and the `path` values.
171171

172172
```sh
173173
$ hookdeck listen 3000 shopify orders

0 commit comments

Comments
 (0)