Add events and resources reference documentation#21375
Conversation
We didn't have any reference documenting the actual events Prefect emits — just the concept page explaining what events are. This adds a new "Events" section under API Reference with pages covering every event from OSS, Cloud, and integrations, including resource labels, related resources, and payloads. Closes CLOUD-3632 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
chrisguidry
requested review from
cicdw,
desertaxle and
zzstoatzz
as code owners
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d7ed7041a1
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Task run state events only include tags as related resources, not the parent flow run or flow. The flow_run_id is in the payload's task_run object instead. Also adds the run-count and orchestration resource labels and the task_run payload field that were missing. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
desertaxle
left a comment
desertaxle
left a comment
There was a problem hiding this comment.
Most of the existing API reference docs have a mechanism to keep them automatically in sync with the code as it changes. It would be great if we could have something similar to keep these pages up to date.
|
@desertaxle Yeah I was trying to figure out how to approach that, do you think a CI task with an LLM making followup PRs makes sense? Or have we had good success with skills + guidance in the repo? |
2 participants
We didn't have any reference documenting the actual events Prefect emits — just the concept page explaining what events are. This adds a new "Events" section under API Reference that catalogs every event from OSS, Cloud, and integrations.
Each event is documented with its name, when it fires, resource ID pattern and labels, related resources and their roles, and payload fields. The section covers:
Also adds cross-links from the existing events concept page and the API reference overview.