hookdeck-cli 0.11.0 → 0.11.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -3
- package/bin/hookdeck +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -105,12 +105,12 @@ hookdeck login
|
|
|
105
105
|
Start a session to forward your events to an HTTP server.
|
|
106
106
|
|
|
107
107
|
```sh-session
|
|
108
|
-
hookdeck listen <port-or-URL> <source-alias?> <connection-query?>
|
|
108
|
+
hookdeck listen <port-or-URL> <source-alias?> <connection-query?> [--path?]
|
|
109
109
|
```
|
|
110
110
|
|
|
111
111
|
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.
|
|
112
112
|
|
|
113
|
-
Each `source` is assigned
|
|
113
|
+
Each `source` is assigned an Event URL, which you can use to receive events. When starting with a fresh account, the CLI will prompt you to create your first source. Each CLI process can listen to one source at a time.
|
|
114
114
|
|
|
115
115
|
Contrary to ngrok, **Hookdeck does not allow to append a path to your event URL**. Instead, the routing is done within Hookdeck configuration. This means you will also be prompted to specify your `destination` path, and you can have as many as you want per `source`.
|
|
116
116
|
|
|
@@ -150,7 +150,27 @@ Shopify Source
|
|
|
150
150
|
🔌 Event URL: https://events.hookdeck.com/e/src_DAjaFWyyZXsFdZrTOKpuHnOH
|
|
151
151
|
|
|
152
152
|
Connections
|
|
153
|
-
|
|
153
|
+
Orders Service forwarding to /webhooks/shopify/orders
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
⣾ Getting ready...
|
|
157
|
+
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
#### Changing the path events are forwarded to
|
|
161
|
+
|
|
162
|
+
The `--path` flag sets the path to which events are forwarded.
|
|
163
|
+
|
|
164
|
+
```sh-session
|
|
165
|
+
$ hookdeck listen 3000 shopify orders --path /events/shopify/orders
|
|
166
|
+
|
|
167
|
+
👉 Inspect and replay events: https://dashboard.hookdeck.com/cli/events
|
|
168
|
+
|
|
169
|
+
Shopify Source
|
|
170
|
+
🔌 Event URL: https://events.hookdeck.com/e/src_DAjaFWyyZXsFdZrTOKpuHnOH
|
|
171
|
+
|
|
172
|
+
Connections
|
|
173
|
+
Orders Service forwarding to /events/shopify/orders
|
|
154
174
|
|
|
155
175
|
|
|
156
176
|
⣾ Getting ready...
|
package/bin/hookdeck
CHANGED
|
Binary file
|