Repository navigation
Summary
This release adds --include data to event and request listings, makes hookdeck listen exit with the reason when Hookdeck rejects your credentials instead of reconnecting forever, and fixes source auth flags and connection rules that were sent or ordered differently from what you asked. Several commands that used to exit 0 while ignoring part of your input now fail: see Improvements / behavior changes and check your scripts.
New features
-
--include dataongateway event list,gateway request listandgateway request eventsreturns each payload (headers, body, path, parsed query) in the list response, so you no longer fetch events one at a time. It works only with--output json: the default list view shows one line per event with no payload, so without--output jsonthe command exits 1 with--include requires --output json. The limit defaults to 10 instead of 100 unless you pass--limit. Theincludeargument is also available on thelistaction ofgateway_events_readandgateway_requests_read. (#488) -
gateway request events --output jsontells you when there is another page. The JSON is a bare array with no cursor, so a short page looked complete. A note on stderr now gives the--nextcursor to pass; stdout is unchanged. (#488)
Fixes
listen
-
hookdeck listenexits with the server's reason when Hookdeck rejects your credentials. When the connection is refused with a 401 or 403, or Hookdeck closes it because your key was revoked,listennow exits 1 and prints the server's message. It previously printed "Connection lost, reconnecting..." and retried forever. Network drops and 503 responses still reconnect. (#477) -
API errors for an organisation that requires MFA now include the setup link,
Set it up here: https://dashboard.hookdeck.com/setup-mfa?..., on gateway commands. (#477) -
hookdeck listen http://127.0.0.1:3000/base/ <source>forwards to/base/webhook, not/base//webhook. A trailing slash on the forwarding URL was joined to the event path with a second slash. (#475) -
listenno longer drops a healthy connection when a pong is about a second late. The client pinged every 9s and closed the socket if no pong arrived within 10s. It now pings every 10s, allows 30s, and treats any incoming frame as proof the connection is alive. (#473)
Connections
-
--rule-*flags build rules in the order you write them. Rules were always built as deduplicate, transform, filter, delay, retry, so--rule-filter-body ... --rule-transform-name ...ran transform first. The position of each type's first flag now sets its position, oncreate,updateandupsert.--rulesand--rules-filekeep the array as given. (#464) -
--rule-transform-nameaccepts a name or an ID, and fails if neither exists. The value was always sent as a new name, so an ID or a mistyped name returned 200 and attached an empty transformation that failed every event. Without--rule-transform-code, an unknown name ortrs_ID is now an error. (#468, #472) -
connection upsert --rules '[]'clears the rules, as--rules-filewith an empty array does. It left them unchanged, and the dry run said so. (#472) -
connection upsertandupdatefail when the destination you pass differs from the stored one. The API never changes an existing connection's destination, so these commands reported success and ignored the flag.upsertnow makes no write and leaves no orphan destination. (#466) -
--rule-retry-response-status-codes "429,500-599"is accepted. The CLI rejected ranges, comparisons (>400) and exclusions (!401), which the API accepts. Each entry is now checked against the API's own pattern. (#496) -
connection createandupsertlistMOCK_APIin--destination-typehelp. The help saidMOCK, which fails withunsupported destination type. (#490)
Sources
-
Auth flags work on WEBHOOK sources, and on GITLAB, GRAFANA, BETTER_STACK, ORDINAL and PROMETHEUS_ALERTMANAGER. These source types support more than one auth method, so the API needs
auth_typeto say which one a flag means. The CLI sent it only for HTTP, so--api-key,--webhook-secretand the basic auth flags returned 422config.auth is not allowed. It now setsauth_typefrom the flag you pass. (#496) -
--webhook-secretno longer overrides a provider's signature header. It sentx-webhook-signature, sha256 and hex for every type except STRIPE. For VAPI, FORMSTACK, BETTER_STACK, GRAFANA and SUPABASE, those values replaced the provider's own, so requests from the provider failed verification. It now sends the secret alone, and adds the HMAC settings only on WEBHOOK and HTTP. (#496) -
source updateandsource upsertkeep the stored type when you omit--type.updatewith config flags failed withconfig is not allowed.upsertconverted an existing non-WEBHOOK source to WEBHOOK and dropped its verification. (#412) -
destination updateandupsertapply--urland--cli-pathwithout--type. (#406)
Transformations
transformation executions get --output jsonreturnsoriginal_event_data,transformed_event_data,logs,log_levelandwebhook_id. Onlyidandcreated_atsurvived decoding.executions listreturnslogs,log_levelandwebhook_id; the API omits the event payloads from list responses. (#472)
Outpost
outpost publishno longer says the topic matched nothing when no destination received the event. An emptydestination_idsalso comes back when the only subscribed destination is disabled, or when--destination-idnames a destination on another tenant. The message now says the event matched no destinations and lists those causes.--output jsonis unchanged. (#448)
MCP
- A slow project display-name lookup no longer stalls tool calls. The lookup ran before every tool call until it succeeded, with no timeout. It now gives up after 5 seconds. (#480)
Improvements / behavior changes
Nothing was removed or renamed, but if you have automation that depended on the old behaviour, these are the ones to check.
-
--outputvalues other thanjsonnow fail.gateway source list --output yamlprinted the human-readable list and exited 0. It now exits 1 withunsupported output format "yaml" (supported: json), on every command whose--outputaccepts onlyjson. Search your scripts for--outputfollowed by anything else.listen --output(interactive,compact,quiet) is unchanged. (#432) -
Source auth flags that a source type cannot use are refused before the request.
--webhook-secreton PROMETHEUS_ALERTMANAGER, BETTER_STACK and ORDINAL, and--api-keyon ORDINAL, GRAFANA, BETTER_STACK and ACUMATICA, now exit 1 and print the--config '{"auth":{...}}'form to use. The--webhook-secretcases already failed with a 422. The--api-keycases created a source that looked for the key in anx-api-keyheader, whatever header you had set up with the provider. Pass the auth object, including its header name, with--configor--config-file. (#496) -
Source auth validation runs again. It had been a no-op since the API spec changed. A command that omits the auth flag its type requires (
--webhook-secretfor AIRCALL), or passes--webhook-secretto PAYPAL, whose auth needswebhook_id, now fails in the CLI before the request. (#341) -
connection updatefails when--source-idor--destination-iddiffers from the stored value. The API never changes an existing connection's source or destination, so the command reported success and ignored the flag. Passing the stored IDs still works. To use a different source or destination, create a new connection. Thegateway_connections_writeMCP tool applies the same check. (#466) -
connection updatechecks--rule-*flags ascreateandupsertdo.connection update <id> --rule-retry-count 5dropped the count, exited 0 and printed the unchanged connection. It now exits 1 and names the missing flag (here--rule-retry-strategy), and makes no change. (#498) -
If you pass
--rule-filter-*before--rule-transform-*and relied on transform running first, filter now runs first. Reorder the flags. (#464) -
listenlinks guest accounts to Hookdeck Inspect (https://inspect.hookdeck.com/?event_id=...&team_id=...) instead of Hookdeck Console. Links for other project types are unchanged. (#484) -
listen --helpnames the default CLI destinationcli-{source}, matching what it creates. It said{source}-cli. (#471)
Internal / reliability / infrastructure
- CI builds and tests with Go 1.26.11 to clear reported standard library vulnerabilities (#474, #493), and runs
build-linuxon Dependabot pull requests without secrets (#482). The npm build check accepts both waysfiledescribes the 32-bit Windows binary (#497). - Acceptance tests: the MCP subprocess helper waits for each response instead of a fixed 20 seconds, and the
listenbinary-delivery test names the missing delivery (#483). The Outpost test uses ahookdeck.devportal domain, which the API still accepts (#499). - The hidden developer override
--console-baseis deprecated and has no effect, and neither doesconsole_basein config. Guest links now use the hidden--inspect-base(orinspect_basein config) (#484). - Dependencies:
golang.org/x/term0.48.0,golang.org/x/sys0.50.0,github.com/spf13/pflag1.1.0,github.com/tidwall/pretty1.3.0 (#470, #495, #487, #494).
Contributors
First merged contributions from @pcbeingused333 (#478, #481, #486, #498, #500), @rahulbhadja (#477) and @garethx (#490). Thank you.
Full Changelog: v3.1.0...v3.2.0