docs(plugins): explain namespaced custom hooks - #241
Open
gabek wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the Owncast plugin documentation to clarify that custom hooks are receiver-owned and namespaced by the receiving plugin slug, and that emitters must target the fully qualified <recipient-slug>.<hook> name across SDKs, permissions, APIs, events reference, and the scenario test harness.
Changes:
- Clarify custom-hook ownership and fully qualified emit targets (
<recipient-slug>.<hook>) across permissions, APIs, and events reference docs. - Update JavaScript/Python SDK docs to describe local hook declarations vs fully qualified names.
- Update scenario testing docs/examples to assert against fully qualified emitted event targets.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/plugins/testing.mdx | Clarifies scenario event dispatch semantics for custom hooks and updates emitted-event assertions/examples. |
| docs/plugins/sdks/python.md | Updates Python SDK mapping and decorator explanation to reflect receiver-owned custom hooks. |
| docs/plugins/sdks/native-wasm.mdx | Documents how native WASM modules receive local hook names while emitters use namespaced targets. |
| docs/plugins/sdks/javascript.md | Updates JS SDK mapping table to reflect receiver-owned custom hooks. |
| docs/plugins/permissions.md | Updates events.emit permission docs to reflect fully qualified recipient hook targets and no host rewriting. |
| docs/plugins/events.mdx | Reframes plugin-to-plugin “custom events” as receiver-owned hooks; updates examples and permission table wording. |
| docs/plugins/apis.mdx | Updates owncast.events.emit reference to require fully qualified <recipient-slug>.<hook> targets and refreshes examples. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
gabek
force-pushed
the
fix/plugin-event-hook-namespacing
branch
from
August 9, 2026 21:25
807ebec to
81555a9
Compare
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
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.
Related to owncast/owncast#5093, owncast/owncast#5119, and owncast/plugin-sdk#16.
Summary
<recipient-slug>.<hook>emit targets.on_eventbehavior for native WebAssembly plugins.Verification
npx docusaurus build --locale encompiled the updated MDX and reached the repository's expected client-redirect validation failure for/development-buildsand/dev-docs/contributor-guide, which are generated by the skipped prebuild. No broken-link, anchor, MDX, or parse errors were reported.Independent SDK and documentation review: clean after fixes.
Merge order
Merge after owncast/owncast#5119 ships and the SDK runtime pin is updated. This PR targets
owncast-docusaurus, where the plugin documentation lives.