getstream webhook
Scope: app
Registers a temporary webhook on your app that points to a local server. Use it to proxy webhook events to your dev server. Ctrl-C to stop.
Webhook events are proxied through a Cloudflare Quick Tunnel. The Cloudflare tunnel utility, cloudflared, is downloaded on first use. Event payloads will pass through the Cloudflare network.
--event filters the event types; without it, all events are forwarded.
The temporary webhook is cleaned up when the command exits or is killed.
Several instances can run at once, each with its own webhook. An abrupt
kill can leave a dangling webhook: --prune removes every webhook this
CLI installation added, including the ones currently being proxied.
Webhook URLs include the unique id (?cliwebhook) for your CLI install.
Like every app-scoped command, webhook acts on the current project's
app unless --app-id or the STREAM_API_KEY and STREAM_API_SECRET
environment variables override it.
getstream webhook [flags]Examples
getstream webhook --port 3000 --path /webhooks/stream
getstream webhook --port 3000 --event message.new --event user.updated
getstream webhook --pruneFlags
| Flag | Description |
|---|---|
--app-id <int> |
id of the app to act on; defaults to the project's app |
-e, --event <stringArray> |
event type to forward (repeatable); all events when omitted |
--https |
forward over HTTPS |
--path <string> |
subpath to forward webhook events to (e.g. /webhooks/stream) |
--port <int> |
local port to forward webhook events to (required) |
--prune |
remove all webhooks set by this command and exit |
-y, --yes |
download cloudflared without asking |
Global flags
| Flag | Description |
|---|---|
--verbose |
print API requests and full error details |