docs: update event notifications for instance upgrade lifecycle events#3891
Merged
AmberAlston merged 3 commits intomainfrom Mar 17, 2026
Merged
docs: update event notifications for instance upgrade lifecycle events#3891AmberAlston merged 3 commits intomainfrom
AmberAlston merged 3 commits intomainfrom
Conversation
…vents Reflects changes from vandoor PR #9180: - Rename Instance Upgraded to Instance Upgrade Started with updated description - Add new Instance Ready event (fires once when app status first becomes ready) - Add new Instance Upgrade Completed event (fires when app is ready after upgrade) - Update Instance Created description to "sends its first check-in" - Update webhook payload example to use instance.upgrade_started - Update license field condition filters list with new event names Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| - **Instance Upgrade Completed**: When an instance's application status is Ready after upgrading to a new release version | ||
| - **Instance Version Behind**: When an instance falls behind by a specified number of versions | ||
| - **Instance Inactive**: When an instance has not reported in for 24 hours (declared "Inactive"). Air-gapped instances are excluded from this event type. | ||
| - **Instance Inactive**: When an instance has not reported for 24 hours (declared "Inactive"). Air-gapped instances are excluded from this event type. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('are excluded').
| - **Instance Upgrade Completed**: When an instance's application status is Ready after upgrading to a new release version | ||
| - **Instance Version Behind**: When an instance falls behind by a specified number of versions | ||
| - **Instance Inactive**: When an instance has not reported in for 24 hours (declared "Inactive"). Air-gapped instances are excluded from this event type. | ||
| - **Instance Inactive**: When an instance has not checked-in for 24 hours (declared "Inactive"). Air-gapped instances are excluded from this event type. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('are excluded').
paigecalvert
approved these changes
Mar 17, 2026
Contributor
paigecalvert
left a comment
paigecalvert
left a comment
There was a problem hiding this comment.
thank you looks good!
| - **Instance Upgraded**: When an instance upgrades to a new release version | ||
| - **Instance Created**: When a new instance sends its first check-in | ||
| - **Instance Ready**: When a new instance's application status is Ready for the first time | ||
| - **Instance Upgrade Started**: When an instance begins upgrading to a new release version. This event fires when the Vendor Portal receives the first telemetry with a new release version, whether or not the application status is Ready. |
Contributor
There was a problem hiding this comment.
note: I ended up editing out the passive voice here, but mainly because I wanted to reword the second sentence for clarity anyway.
| - **Instance Upgrade Completed**: When an instance's application status is Ready after upgrading to a new release version | ||
| - **Instance Version Behind**: When an instance falls behind by a specified number of versions | ||
| - **Instance Inactive**: When an instance has not reported in for 24 hours (declared "Inactive"). Air-gapped instances are excluded from this event type. | ||
| - **Instance Inactive**: When an instance has not checked-in for 24 hours (declared "Inactive"). Air-gapped instances are excluded from this event type. |
Contributor
There was a problem hiding this comment.
We typically use "check-in" rather than "report in" to talk about an instance being active or inactive
| - **Instance Created**: When a new instance is created | ||
| - **Instance Upgraded**: When an instance upgrades to a new release version | ||
| - **Instance Created**: When a new instance sends its first check-in | ||
| - **Instance Ready**: When a new instance's application status is Ready for the first time |
Contributor
There was a problem hiding this comment.
When a new instance's application status is Ready
I've capitalized mentions of a "Ready" status because it's referring to the status' name (proper noun) versus just the word ready.
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
3 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.
Preview link: https://deploy-preview-3891--replicated-docs-upgrade.netlify.app/vendor/event-notifications-create#instance-events
Summary
Updates Event Notifications docs to reflect changes from vandoor PR #9180:
instance.upgrade_startedTest plan
🤖 Generated with Claude Code