Skip to content

feat(relay): look up a platform's --metadata keys instead of a hardcoded table (v2.17.0) - #245

Merged
paulkr merged 1 commit into
mainfrom
feat/relay-metadata-fields
Nov 20, 2026
Merged

paulkr merged 1 commit into
mainfrom
feat/relay-metadata-fields

Conversation

@paulkr

@paulkr paulkr commented Nov 20, 2026 •

Copy link
Copy Markdown
Member

What this does

  • New one relay metadata <platform>. It reads the setup fields One already stores per platform (GET /v1/webhooks/relay/config/{connectorId}, the list the dashboard's Configuration step shows). For each key it prints the label, whether it's required, and whether it's a secret. A secret field's placeholder is never repeated, because some stored placeholders look like real secrets.
  • relay create --create-webhook checks the required keys first. When one is missing it returns "status": "metadata_required" with the missing fields, exits 1, and creates nothing. Before, the endpoint was created, the webhook never registered, and only a warning said why. If the list can't be read, or One stores none for the platform, create goes ahead as before.
  • The hardcoded 49-row table is gone from skills/one/references/relay.md and one guide relay. Both now point at the command. README and --help updated. Version 2.17.0.

No backend change: the endpoint already exists and accepts API keys.

Merge after the integration team fixes four config rows

The stored rows are hand-maintained and some have drifted from the server code. Most gaps only mean the check has nothing to go on (it falls back to today's warning). Four rows, though, mark a key required that the code doesn't need, so once this ships the CLI would ask for it:

  • fillout: FILLOUT_SIGNING_SECRET is never read
  • typeform: TYPEFORM_TAG has a default
  • linear: LINEAR_TEAM_ID is optional (requiring it narrows the webhook to one team)
  • whop: WHOP_ACCOUNT_ID is optional

The full list for the integration team covers all 105 platforms.

Checks

  • New tests: 7, in src/commands/relay-metadata.test.ts, against a fake API.
  • Full suite: 937 of 945 pass (rebased on fix: abort timed-out flow action requests #241). The 6 failures are the resolveConfig tests, which fail the same way on a clean main on this machine.
  • Typecheck: passes.
  • Live, read-only, against api.withone.ai:
    • relay metadata github, monday and stripe return the stored fields, or an empty list for stripe.
    • relay create --create-webhook with a made-up GitHub connection key and only GITHUB_OWNER is refused (exit 1) before any request to create.
    • With both keys it gets past the check and fails with "Connection not found", so nothing was created.

Related

  • Website: withoneai/landing#191 (same change on the docs pages; merge after this is published)
  • Dashboard: withoneai/core-ui#1154 (honours optional in the webhook form; same prompt)

🤖 Generated with Claude Code

…ded table (v2.17.0)

`one relay metadata <platform>` reads the setup fields One already stores
per platform (GET /v1/webhooks/relay/config/{connectorId}, the list the
dashboard's Configuration step shows) and prints each key with its label,
whether it's required, and whether it's a secret. A secret field's
placeholder is never repeated.

`relay create --create-webhook` checks the required keys before calling
the API. When one is missing it returns `status: "metadata_required"`
with the missing fields, exits 1, and creates nothing. Before, the
endpoint was created, the webhook never registered, and only a warning
said why. When the field list can't be read, or One stores none for the
platform, create goes ahead as before.

The 49-row metadata table in the skill and `one guide relay` is gone;
both now point at the command. README and --help updated.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@paulkr
paulkr force-pushed the feat/relay-metadata-fields branch from 6b8d9fc to 831518b Compare November 20, 2026 03:02
@paulkr
paulkr merged commit 82491ee into main Nov 20, 2026
8 checks passed
@paulkr
paulkr deleted the feat/relay-metadata-fields branch November 20, 2026 03:09
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