Document webhook custom URLs - #849
Open
elias-ba wants to merge 1 commit into
Open
Conversation
The Webhook Event Triggers section never said what a webhook's URL looks like or where to find it, so there was nothing to extend: a reader had no way to learn that a trigger can now answer on a name you choose as well as on its id. Covers both URL shapes, what a name may contain, that names are unique per project, and that renaming or removing one breaks it with no redirect. That last one is the trap worth the warning, since the sending system has to be updated first.
elias-ba
marked this pull request as draft
September 4, 2026 22:59
elias-ba
marked this pull request as ready for review
September 5, 2026 02:25
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
1 participant
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
Documents webhook custom URLs on the Triggers page. A webhook trigger can be given a name, so it answers on
/i/<project-id>/<name>as well as on its generated/i/<trigger-id>URL.Details
The page never said what a webhook's URL looks like or where to find it, so this is the first time it explains them at all. The new section covers both URL shapes, what a name may contain, that names are unique within a project, and that renaming or removing one breaks it with no redirect.
The rules are taken from the implementation rather than from the feature description. Shipped in OpenFn/lightning#5105 and OpenFn/lightning#5111, with the CLI half in OpenFn/kit#1511.
The Kafka trigger docs on this same page are stale for a different reason, and #850 handles that separately.
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