Skip to content

v3.2.0

Latest

Choose a tag to compare

@leggetter leggetter released this 16 Nov 11:50
· 1 commit to main since this release
96e975a

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 data on gateway event list, gateway request list and gateway request events returns 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 json the command exits 1 with --include requires --output json. The limit defaults to 10 instead of 100 unless you pass --limit. The include argument is also available on the list action of gateway_events_read and gateway_requests_read. (#488)

  • gateway request events --output json tells 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 --next cursor to pass; stdout is unchanged. (#488)

Fixes

listen

  • hookdeck listen exits 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, listen now 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)

  • listen no 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, on create, update and upsert. --rules and --rules-file keep the array as given. (#464)

  • --rule-transform-name accepts 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 or trs_ ID is now an error. (#468, #472)

  • connection upsert --rules '[]' clears the rules, as --rules-file with an empty array does. It left them unchanged, and the dry run said so. (#472)

  • connection upsert and update fail 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. upsert now 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 create and upsert list MOCK_API in --destination-type help. The help said MOCK, which fails with unsupported 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_type to say which one a flag means. The CLI sent it only for HTTP, so --api-key, --webhook-secret and the basic auth flags returned 422 config.auth is not allowed. It now sets auth_type from the flag you pass. (#496)

  • --webhook-secret no longer overrides a provider's signature header. It sent x-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 update and source upsert keep the stored type when you omit --type. update with config flags failed with config is not allowed. upsert converted an existing non-WEBHOOK source to WEBHOOK and dropped its verification. (#412)

  • destination update and upsert apply --url and --cli-path without --type. (#406)

Transformations

  • transformation executions get --output json returns original_event_data, transformed_event_data, logs, log_level and webhook_id. Only id and created_at survived decoding. executions list returns logs, log_level and webhook_id; the API omits the event payloads from list responses. (#472)

Outpost

  • outpost publish no longer says the topic matched nothing when no destination received the event. An empty destination_ids also comes back when the only subscribed destination is disabled, or when --destination-id names a destination on another tenant. The message now says the event matched no destinations and lists those causes. --output json is 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.

  • --output values other than json now fail. gateway source list --output yaml printed the human-readable list and exited 0. It now exits 1 with unsupported output format "yaml" (supported: json), on every command whose --output accepts only json. Search your scripts for --output followed 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-secret on PROMETHEUS_ALERTMANAGER, BETTER_STACK and ORDINAL, and --api-key on ORDINAL, GRAFANA, BETTER_STACK and ACUMATICA, now exit 1 and print the --config '{"auth":{...}}' form to use. The --webhook-secret cases already failed with a 422. The --api-key cases created a source that looked for the key in an x-api-key header, whatever header you had set up with the provider. Pass the auth object, including its header name, with --config or --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-secret for AIRCALL), or passes --webhook-secret to PAYPAL, whose auth needs webhook_id, now fails in the CLI before the request. (#341)

  • connection update fails when --source-id or --destination-id differs 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. The gateway_connections_write MCP tool applies the same check. (#466)

  • connection update checks --rule-* flags as create and upsert do. connection update <id> --rule-retry-count 5 dropped 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)

  • listen links 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 --help names the default CLI destination cli-{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-linux on Dependabot pull requests without secrets (#482). The npm build check accepts both ways file describes the 32-bit Windows binary (#497).
  • Acceptance tests: the MCP subprocess helper waits for each response instead of a fixed 20 seconds, and the listen binary-delivery test names the missing delivery (#483). The Outpost test uses a hookdeck.dev portal domain, which the API still accepts (#499).
  • The hidden developer override --console-base is deprecated and has no effect, and neither does console_base in config. Guest links now use the hidden --inspect-base (or inspect_base in config) (#484).
  • Dependencies: golang.org/x/term 0.48.0, golang.org/x/sys 0.50.0, github.com/spf13/pflag 1.1.0, github.com/tidwall/pretty 1.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