docs(webhooks): drop poll and avatar content arms — not officially supported - #61
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
|
Warning Review limit reached
More reviews will be available in 3 minutes and 8 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
What
Removes the
poll/poll_optionandavatarcontent arms from the public webhook wire-spec documentation.Why
Product decision: neither polling nor avatars are officially supported yet, so the public docs shouldn't list them as first-class content types. The runtime serializer in
spectrum-webhookcontinues to handle both arms — only the customer-facing docs change. A poll- or avatar-shaped payload that does reach a customer endpoint falls through the documentedSerializedUnknownContenttail, which matches the "not yet supported" framing.What changed
pollandpoll_optionaccordion blocks from the per-arm wire reference indocs-src/webhooks/events.mdx.velavataraccordion block from the same per-arm wire referenceavatarfrom the byte-bearing-arms warning callout (nowattachment/voice/contact.photoonly)Out of scope
Several SDK pages (
spectrum-ts/content.mdx,spectrum-ts/providers/imessage.mdx,advanced-kits/imessage/polls.mdx, etc.) still publicly document thepoll(...)andavatar(...)content builders. That's a separate follow-up if the "not officially supported" framing should extend to SDK how-to pages.Test plan
pnpm docs:generate— cleanpnpm typecheck:docs— cleanpnpm lint— cleanrg -i 'poll|avatar' docs-src/webhooks/ webhooks/— only verb-sense matches remain (you poll, you waitin overview)Split out of #60 — that PR stays focused on the per-arm wire-spec sync.
Made with Cursor
Need help on this PR? Tag
@codesmithwith what you need. Autofix is disabled.