Skip to content

Document HTTP workflow connector support#6885

Open
talboren wants to merge 3 commits into
elastic:mainfrom
talboren:update-workflows-http-connector-docs
Open

Document HTTP workflow connector support#6885
talboren wants to merge 3 commits into
elastic:mainfrom
talboren:update-workflows-http-connector-docs

Conversation

@talboren

@talboren talboren commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Updates the Workflows HTTP actions docs to explain connector-backed HTTP steps.
  • Replaces the outdated secret-store limitation with guidance to use connector-id for authenticated requests.
  • Adds dropdown syntax examples for configured HTTP connector and direct URL usage.

Testing

  • Not run; docs-only change.

@talboren talboren requested review from a team as code owners June 10, 2026 07:44
@github-actions

github-actions Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check 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.

@github-actions

github-actions Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

🔍 Preview links for changed docs

@github-actions

Copy link
Copy Markdown
Contributor

✅ 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.

@semd semd left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Neat!

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 to Syntax examples or Click to show syntax examples to match the content.
  • Line 78 — url Required column: "Yes, when connector-id is not provided" is clear but verbose for a table cell. A shorter alternative like "Yes (if no connector-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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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:

Suggested change
* **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.
:::

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.

3 participants