Skip to content

[PLT-3079] docs: add the unified eventing guide - #1146

Open
TheMostlyGreat wants to merge 14 commits into
mainfrom
codex/unified-eventing-guide
Open

[PLT-3079] docs: add the unified eventing guide#1146
TheMostlyGreat wants to merge 14 commits into
mainfrom
codex/unified-eventing-guide

Conversation

@TheMostlyGreat

@TheMostlyGreat TheMostlyGreat commented Aug 28, 2026

Copy link
Copy Markdown

Why

Developers need one accurate path through triggers, schedules, retained events, and signed outgoing webhooks before eventing can ship.

What

  • adds one /build/eventing guide with the producer → event → subscription → delivery model
  • includes scoped Dashboard and REST walkthroughs for Gmail and schedules
  • documents signature verification, stable delivery IDs, retries, recovery/replay, retention, and cleanup
  • adds executable guide and Python receiver contract tests

Verification

  • focused eventing tests: 21/21 pass
  • full docs suite: 873/873 pass
  • lint and typecheck: clean
  • production build: /en/build/eventing rendered successfully
  • GitHub checks, including Vale and generated LLM text: green

Merge gate

Ready for review. Merge and publication remain intentionally gated on the corresponding Engine eventing release.

Linear: https://linear.app/arcadedev/issue/PLT-3079


Note

Low Risk
Documentation, examples, and tests only—no runtime product code paths change.

Overview
Adds a new Build → Events and webhooks page at /en/build/eventing that documents Arcade eventing end-to-end: producers (trigger instances, schedules, provider ingress) through retained project events to webhook subscriptions and signed deliveries.

The guide includes a seven-term model, deployment origins and scoped REST paths, a framework-free Python receiver (verify_request, SQLite idempotency inbox, receive with 400/403/500/204 semantics), Dashboard and REST walkthroughs for schedules, filtered Gmail triggers, and Slack/GitHub provider ingress, plus operations (rotate secret, recover, replay) and reliability boundaries (retries, stable webhook-id, retention).

Ships examples/eventing/receiver.py mirrored in the MDX snippet, Vitest contracts on guide content/navigation, and Python unittest coverage for signatures, rotation, duplicates, and transactional rollback. public/llms.txt lists the new page; .gitignore ignores Python cache for examples/tests.

Reviewed by Cursor Bugbot for commit e7581a5. Bugbot is set up for automated code reviews on this repo. Configure here.

@vercel

vercel Bot commented Aug 28, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 29, 2026 4:31pm

Request Review

@TheMostlyGreat
TheMostlyGreat force-pushed the codex/unified-eventing-guide branch from ebe76a5 to 558d09b Compare August 29, 2026 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant