Document HTTP workflow connector support#6885
Conversation
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
🔍 Preview links for changed docs |
✅ Elastic Docs Style Checker (Vale)No issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
There was a problem hiding this comment.
Docs review summary
Focus areas
- Style and clarity: Good overall. The rewritten HTTP actions section is clearer and more accurate than the previous version. One inline comment on security guidance visibility.
- Jargon: No unexplained jargon.
connector-id,url, and YAML terms are used appropriately in a technical context. - Frontmatter and applies_to: Not modified by this PR; no issues.
- Content type fit: Appropriate reference/how-to hybrid structure for this topic.
- Parent issue satisfaction: Not applicable — no linked issue referenced.
Nits
- Line 85 — dropdown label: The PR adds a second example inside the dropdown, but the heading still reads
Click to show syntax example(singular). Consider updating it toSyntax examplesorClick to show syntax examplesto match the content. - Line 78 —
urlRequired column: "Yes, whenconnector-idis not provided" is clear but verbose for a table cell. A shorter alternative like "Yes (if noconnector-id)" would be more scannable.
Generated by Docs review agent for issue #6885 · 102.3 AIC · ⌖ 17.7 AIC · ⊞ 32.5K
| The native `http` action is a built-in HTTP client for calling external APIs. It supports two modes: | ||
|
|
||
| * **Configured HTTP connector**: For authenticated requests, first [configure an HTTP connector](/deploy-manage/manage-connectors.md). Then reference it from the workflow step with `connector-id`. The connector stores the base URL, authentication settings, and secrets using {{kib}}'s centralized {{connectors-ui}} framework. | ||
| * **Direct URL**: For simple requests that don't require connector-managed secrets, omit `connector-id` and provide the full `url` directly in the step. Avoid placing secrets directly in workflow YAML. |
There was a problem hiding this comment.
The sentence "Avoid placing secrets directly in workflow YAML." is important security guidance, but it's buried at the end of a descriptive bullet. This guidance was previously more prominent as a dedicated admonition. Consider elevating it:
| * **Direct URL**: For simple requests that don't require connector-managed secrets, omit `connector-id` and provide the full `url` directly in the step. Avoid placing secrets directly in workflow YAML. | |
| * **Direct URL**: For simple requests that don't require connector-managed secrets, omit `connector-id` and provide the full `url` directly in the step. | |
| :::{warning} | |
| Avoid placing secrets directly in workflow YAML. Use a configured HTTP connector for authenticated requests. | |
| ::: |
Summary
connector-idfor authenticated requests.Testing