Conversation
Custom events had no narrative documentation. The only coverage was the auto-generated API reference at /api/event-catalog, which renders the live spec but explains nothing: not the draft/publish/deprecate lifecycle, not graph projection, not how custom events reach webhooks and automations. Adds docs/integrations/custom-events.md covering: - how custom events differ from core events, and why an org-specific event cannot be a built-in - anatomy: root entity, entity graph, graph_source projection, guided vs JSONata mapping, trigger sources, assembled payload shape - the five-step builder in epilot 360 - the draft -> active -> deprecated lifecycle and what is immutable when - deriving from a built-in event and the restrictions that are inherited - consuming events via webhooks (event_<EventName>) and automations - a worked API walkthrough: create, preview, publish, trigger, deprecate - reference: naming rules, limits, reserved field names, validation, and the current v1 limitations Also regenerates the SDK event-catalog client reference, which predated the custom event operations and listed 7 of the API's 15 operations. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
What
Adds Custom Events to the Integrations section — the first narrative documentation for the Event Catalog's custom event feature.
Until now the only coverage was the auto-generated API reference at
/api/event-catalog. It renders the live spec, so the five custom-event operations appear there, but nothing explained the lifecycle, the projection model, or how a custom event reaches webhooks and automations. A repo-wide search for "custom event" returned no related hits.The new page
docs/integrations/custom-events.md(sidebar position 4, right after Core Events):graph_sourceprojection, guided vs JSONata mapping, the three trigger sources, and the assembled payload with a full exampleevent_<EventName>), automations in both directions, schema and history endpointscurlContent is sourced from the published OpenAPI spec, the
event-catalog-apihandlers and validators, and theepilot360-event-catalogbuilder — not from the original RFC, which predates several shipped decisions.Also in this MR
docs/sdk/clients/event-catalog.mdregenerated. It predated custom events and listed 7 of the API's 15 operations. Now includescreateCustomEvent,replaceCustomEventDraft,previewCustomEvent,publishCustomEventDefinition,deprecateCustomEvent, pluslistEventVersions,searchEventHistoryV2andgetHistoricalEvent.Not in this MR
The CLI reference (
docs/cli/commands/event-catalog.md) is still stale — same 7 operations. Its upstream source,sdk-js/packages/cli/docs/, is itself out of date, sonpm run update-clicannot fix it from here. It needspnpm generateinsdk-js/packages/clifirst, which also regenerates that package'ssrc/anddefinitions/— a separate MR insdk-js.Verification
npm run buildpasses. The site setsonBrokenLinks: 'throw', so every link in the new page resolves, and the mermaid diagram renders.npm run linthas 24 pre-existing prettier errors insrc/components/{AgentToolkitPromo,CollapsibleJsonViewer,LottieAnimation}.tsx, all onmainand untouched here — this MR adds nothing undersrc/.🤖 Generated with Claude Code