Skip to content

docs(webhook): clarify header authentication in SDK examples - #262

Open
olavurellefsen wants to merge 1 commit into
mainfrom
docs/webhook-header-auth
Open

olavurellefsen wants to merge 1 commit into
mainfrom
docs/webhook-header-auth

Conversation

@olavurellefsen

@olavurellefsen olavurellefsen commented Sep 28, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Explain the existing raw Authorization header contract for single and batch webhook ingestion.
  • Show an API-key client initialized from environment-backed secrets.
  • Assert that SDK single and batch ingest requests contain no URL query parameters.

Verification

  • bun test: 243 passed.
  • bun run typecheck: passed.
  • bunx biome lint test/fixtures/fetch.fixture.ts test/tests/commands/ingestion.test.ts: passed.
  • Biome formatting on the touched test files reports pre-existing formatting differences.

Part of P4b (29ca9e27-f9ad-4afb-bd50-73f11a6d7711). The SDK already sends the raw API key in Authorization; this change documents and locks down that contract.


Human review context

This PR is part of the Flowcore API-key remediation review brief. Please use the brief for the cross-repository review order and design questions. Code review is requested now; merge, deployment, monitor activation, and credential rotation remain separate gates.

@olavurellefsen
olavurellefsen marked this pull request as ready for review September 29, 2026 05:19
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