Add Channels documentation page - #839
Open
brandonjackson wants to merge 2 commits into
Open
Conversation
Document the Channels reverse proxy feature: creating channels, client and destination credentials, sending requests through the proxy, channel logs, security notes, limitations, and troubleshooting. Co-Authored-By: Claude <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01U4hFwx8sQMfAMfZPydRYxN
Channels isn't a workflow feature, so it sits as a sibling of Build & Manage Workflows, above Subscriptions. Co-Authored-By: Claude <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01U4hFwx8sQMfAMfZPydRYxN
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Short Description
Adds a new "Channels" page to the Platform section documenting the Channels
reverse proxy feature, and registers it in the sidebar under Build & Manage
Workflows (after Collections).
Details
The page is based on the internal "Beginner's Guide: Using OpenFn Channels"
draft, with key context folded in from the Channels feature handover doc
(OpenHIM positioning, pass-through framing, and known limitations: no TCP/TLS
passthrough, no path transformation, no ATNA auditing).
Every claim was verified against the Lightning code, which surfaced several
corrections to the drafts worth checking during review:
key), selected via checkboxes; the page links to the Webhook Security docs
OAuth credential types are supported (OAuth tokens auto-refresh)
x-forwarded-hostandx-forwarded-protoheaders; cookies and the client's own auth headers are stripped
502failure mode (destination credential can't be resolved),real request statuses (Pending/Success/Failed/Timeout/Error), payload
wiping per the project's Data Storage settings, role permissions, and the
disable-instead-of-delete behaviour for channels with history
localhostcurl examples with the Hacker News example from thehandover doc
The page intentionally avoids the internal "80% of OpenHIM" claim and instead
says Channels covers the core reverse-proxy use case natively.
AI Usage
Please disclose how you've used AI in this work (it's cool, we just want to
know!):
You can read more details in our
Responsible AI Policy
🤖 Generated with Claude Code
https://claude.ai/code/session_01U4hFwx8sQMfAMfZPydRYxN
Generated by Claude Code