fix: describe what each Kosli Actions trigger fires on and correct the webhook event_type - #412
Conversation
…e webhook event_type The Artifact changed trigger (ON_SCALED_ARTIFACT) was described as firing when instances are scaled up or down. Scaling events are no longer recorded; the trigger fires when a running artifact becomes compliant or non-compliant or gains new provenance. Replace the trigger list with a table that maps UI label to API value and states the exact condition for each. The webhook example showed event_type ARTIFACT_STARTED; the actual value is STARTED_ARTIFACT. List all possible event_type values below the example. Closes #411
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Claude finished @dangrondahl's task in 1m 52s —— View job Doc review — PR #412Reviewed at Improvement
SuggestionPR description no longer matches the branch. Not findings
Swept the rest of the site for scaling prose the PR's premise invalidates: the only remaining hits outside generated pages are 1 Improvement, 1 Suggestion. Advisory only — not blocking. |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
Kosli no longer records instance scaling events. Drop the "instance scaling" example from the commit-to-production tutorial description and the "Scaled up from 1 to 3" line from the sample search output in the querying tutorial, since that event can no longer be produced.
The stale "Scaled up" line is removed as part of the full tutorial refresh in #413, so this PR no longer needs to touch the file.
|
Status of the review findings at
No open threads remain. |
…data (#413) ## Summary Running `tutorials/querying_kosli.md` as written no longer works. cyber-dojo renamed its flows to `*-ci`, so `kosli list artifacts --flow creator` and `kosli get artifact creator:344430d` fail with "Flow named 'creator' does not exist". The search example resolves to an archived flow with 2022 timestamps, and the `aws-beta aws-beta~1` diff example prints nothing today because the two latest snapshots run the same artifacts. This refresh: - Follows one current commit (`creator` 99d7b74) through every step: search, list artifacts, get artifact, the snapshot where it started running, and the diff that shows its deployment. - Replaces every sample output with what the CLI prints today, including the newer TAGS, POLICIES, COMPLIANT, and COMPLIANCE columns. - Uses a snapshot pair that actually differs (`aws-beta#8339` vs `#8338`) for the diff example, explains that an empty diff means nothing changed, and mentions `--show-unchanged`. - Notes that one commit can produce several artifacts, since search now also lists Terraform state artifacts for the same commit. - Explains the `VISIBILITY` column: a legacy per-flow field that does not control access. Access comes from the organization's visibility. This spawned kosli-dev/cli#1169 to drop the column. Setup sweep across the three cyber-dojo tutorials, from review: - All three (`querying_kosli`, `following_a_git_commit_to_runtime_environments`, `tracing_a_production_incident_back_to_git_commits`) now use the same copy-pasteable Setup block with `KOSLI_API_TOKEN=ignored`, since cyber-dojo is public and the CLI only needs a non-empty value. A placeholder is used deliberately instead of a real-looking token, to avoid secret scanners and to avoid implying a real token is required. - The API token prerequisite is optional on all three. - The commit-to-production tutorial's `kosli list flows` table is refreshed; it listed two flows that no longer exist. The rest of that page is still stale and deserves its own refresh. No page files move, no navigation or redirect changes. ## Verification Every command on the querying page was run against cyber-dojo on 2026-09-14 and the outputs pasted from those runs, trimmed with `[...]` where long. The placeholder token was verified to read every flow. Related: #412 also touched `following_a_git_commit_to_runtime_environments.md` (frontmatter description only). The hunks do not overlap.
This branch was successfully deployed
2 participants
Summary
The Kosli Actions page described the "Artifact changed" trigger as firing "when instances of an artifact are scaled up or down". Scaling events are no longer recorded, and that trigger fires when an artifact that is already running becomes compliant or non-compliant, or gains new provenance. Readers who set it up expecting a notification on a new deployment got nothing.
Changes to
integrations/kosli_actions.md:ON_SCALED_ARTIFACTkeeps its historical name for API compatibility and never fires on replica count changes.kosli_actionpage so readers can connect the three surfaces.ARTIFACT_STARTEDtoSTARTED_ARTIFACTand list all six possibleevent_typevalues below it.Adjacent stale scaling prose, flagged in review:
tutorials/following_a_git_commit_to_runtime_environments.md: the description no longer lists "instance scaling" as a runtime event Kosli shows.tutorials/querying_kosli.md: the stale "Scaled up from 1 to 3" line is handled by the full tutorial refresh in docs: refresh the querying Kosli tutorial against current cyber-dojo data #413 instead, so this PR no longer touches that file.The upstream fix for the Terraform
kosli_actionexample and schema descriptions is kosli-dev/terraform-provider-kosli#262.Closes #411
Verification
PUT /actions/{org}/environmentshas the summary "Create or update environment action", which slugifies to the linked path.mint broken-linksreports one broken link, intutorials/working_with_controls.mdx. It pre-exists onmainand is unrelated to this change.