docs: add a Smart Objects reference - #16
Merged
Merged
Conversation
gesposito
changed the title
yaustar
approved these changes
Jul 28, 2026
The repo documented each example package well but had no central reference for the Smart Object model itself — the gap called out in integrator feedback (the in-app setup prompt carried far more detail than the repo or the Knowledge Base). Add docs/reference.md: the wire model (signed POST via the SDK), the four presets and their capabilities, every capability's events and argument constraints, the status states, and a map of which example drives which preset. Linked from a short "Smart Objects" section in the README.
gesposito
force-pushed
the
gianluca/gco-2287-smart-objects-reference
branch
from
July 28, 2026 16:25
b217bfd to
d166634
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
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.
The repo has strong per-example READMEs but no central reference for the Smart Object model itself, so an integrator can't see what objects can do without reading the SDK types or the in-app setup prompt. This adds
docs/reference.md, linked from a short "Smart Objects" section in the README.Details
@gathertown/webhook-object-sdk), the four presets and their capabilities, every capability's events with argument constraints, the status states, and a table mapping each example package to its preset.counter.decrementis included; it ships with the next@gathertown/webhook-object-typesrelease.--checked version of this doc is the natural follow-up so it can't drift from the catalog.Test Plan
docs/reference.md, anddocs/reference.md→ each../packages/*.Note
Low Risk
Documentation-only changes with no runtime, auth, or data-path impact.
Overview
Adds a central Smart Objects reference so integrators can see presets, capabilities, and event contracts without digging through per-package READMEs or SDK types alone.
docs/reference.mddocuments the webhook model (per-object URL/secret, Standard Webhooks signing, SDK usage), the four presets and their capabilities, every capability’s events with argument limits, and a table mapping each example package to its preset.README.mdgains a short Smart Objects section that points to that doc.Reviewed by Cursor Bugbot for commit d166634. Bugbot is set up for automated code reviews on this repo. Configure here.