Skip to content

Add channels webhook hmac show (AIT-183) - #24

Merged
ord669 merged 2 commits into
mainfrom
ait-183-webhook-hmac-show
Jul 15, 2026
Merged

Add channels webhook hmac show (AIT-183)#24
ord669 merged 2 commits into
mainfrom
ait-183-webhook-hmac-show

Conversation

@ord669

@ord669 ord669 commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Summary

  • New hookmyapp channels webhook hmac show <channel> — reads the HMAC signing secret (X-HookMyApp-Signature-256) from the new GET /webhook-config/:channelId/hmac endpoint
  • channels webhook show keeps webhookUrl + verifyToken only; the two secrets are no longer bundled in one payload (Verify Token ≠ HMAC)
  • Help EXAMPLES blocks for the new hmac group + hmac show

Backend companion: hookmyapp/hookmyapp#100.

Test plan

  • New unit test: hmac show hits /webhook-config/:id/hmac, outputs kind: 'read'
  • Full suite 940/940 green, tsc --noEmit clean

Summary by CodeRabbit

  • New Features
    • Added hookmyapp channels webhook hmac show <channel> to display a channel’s webhook HMAC configuration.
    • Added --json support for the command output.
    • Updated CLI help and examples with the new command and usage.
  • Tests
    • Added a test covering HMAC configuration retrieval and formatted output.
    • Updated starter-kit alignment checks to include VERIFY_TOKEN.

… surface (AIT-183)

channels webhook show no longer receives hmacSecret bundled with verifyToken
(backend split). New command reads it from GET /webhook-config/:id/hmac:

  hookmyapp channels webhook hmac show <channel>
@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d4980702-c67e-4664-a8f2-d74b5c75d8d7

📥 Commits

Reviewing files that changed from the base of the PR and between 2c34f2d and 8a48772.

📒 Files selected for processing (1)
  • src/__tests__/starter-kit-alignment.test.ts

📝 Walkthrough

Walkthrough

Adds hookmyapp channels webhook hmac show to resolve a channel, fetch its HMAC configuration, output the secret, support JSON formatting, document usage, and test the API and formatter behavior. It also adds VERIFY_TOKEN to the canonical environment key expectations.

Changes

Webhook HMAC show

Layer / File(s) Summary
HMAC retrieval handler
src/commands/webhook.ts
Adds runChannelWebhookHmacShow to resolve the channel, fetch /webhook-config/:channelId/hmac, and output the result as a read operation.
CLI wiring and validation
src/commands/channels.ts, src/__tests__/webhook.test.ts, src/__tests__/starter-kit-alignment.test.ts
Registers the hmac show subcommand, propagates JSON mode, documents command examples, verifies endpoint and output behavior, and includes VERIFY_TOKEN in the canonical environment key set.

Estimated code review effort: 2 (Simple) | ~10 minutes

Sequence Diagram(s)

sequenceDiagram
  participant CLI
  participant runChannelWebhookHmacShow
  participant API
  participant output
  CLI->>runChannelWebhookHmacShow: invoke with channel and JSON option
  runChannelWebhookHmacShow->>API: GET /webhook-config/:channelId/hmac
  API-->>runChannelWebhookHmacShow: return HMAC secret
  runChannelWebhookHmacShow->>output: render secret as a read result
Loading

Possibly related PRs

  • hookmyapp/cli#1: Both update channel-based webhook flows and resolve channel identifiers for webhook configuration requests.
  • hookmyapp/cli#11: Both modify canonical webhook-related environment key expectations in the starter-kit alignment test.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely names the main change: adding the channels webhook HMAC show command.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch ait-183-webhook-hmac-show

Comment @coderabbitai help to get the list of available commands.

@ord669
ord669 merged commit 2524d60 into main Jul 15, 2026
3 checks passed
@ord669
ord669 deleted the ait-183-webhook-hmac-show branch July 15, 2026 14:36
ord669 added a commit that referenced this pull request Aug 12, 2026
* feat(channels): add webhook hmac show — HMAC secret gets its own read surface (AIT-183)

channels webhook show no longer receives hmacSecret bundled with verifyToken
(backend split). New command reads it from GET /webhook-config/:id/hmac:

  hookmyapp channels webhook hmac show <channel>

* test: starter-kit canonical env keys include VERIFY_TOKEN (drift from AIT-179)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant