Skip to content

Clarify detect_machine event and variable values#336

Merged
hey-august merged 2 commits into
signalwire:mainfrom
Lucas-FManager:codex/clarify-detect-machine-333
Jun 5, 2026
Merged

Clarify detect_machine event and variable values#336
hey-august merged 2 commits into
signalwire:mainfrom
Lucas-FManager:codex/clarify-detect-machine-333

Conversation

@Lucas-FManager
Copy link
Copy Markdown

Summary

  • Clarifies that detect.params.event and ${detect_result} are separate surfaces with different value sets and casing.
  • Splits callback event values into detection outcomes and lifecycle markers.
  • Adds the missing ${detect_result} values detecting and error, and fixes a small SWML typo in the same section.

Root cause

The page listed callback events and showed lowercase ${detect_result} examples without explicitly saying these are separate contracts. That made READY, NOT_READY, and finished look like possible ${detect_result} values even though they are callback lifecycle events only.

Code shape

One MDX documentation page changed. The update is intentionally local to the detect_machine reference page; no generated code, schemas, runtime behavior, or wire-format casing changed.

Security assessment

Low risk: documentation-only change. No executable code, dependency, auth behavior, network request handling, secrets, or customer data path changed.

Verification

  • rg -n "detect_result|READY|NOT_READY|finished|SWML|SMWL|machine \\| human \\| fax \\| unknown \\| detecting \\| error" fern\\products\\swml\\pages\\reference\\methods\\calling\\detect_machine.mdx
  • git diff --check

Note: I did not run the full Fern docs check locally because this workspace is a sparse checkout and does not have the full docs dependency/config tree installed.

Fixes #333

Copy link
Copy Markdown
Collaborator

@hey-august hey-august left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great edits. Thank you for helping us improve the SignalWire docs!

@hey-august hey-august merged commit 6adaf67 into signalwire:main Jun 5, 2026
0 of 2 checks passed
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.

whats a valid variable vs event payload (detect_machine)

2 participants