docs: Revise some content related to flow triggers, including the webhook trigger process and some /run endpoint examples.

[aimurphy]

• Reorganize some content and update some syntax in api-flows-run.md
• In Get started with the Langflow API:
  • Add a basic request example near the top of the page for users that prefer to see code ASAP
  • In the Authentication section, suggest using env var for auth keys, and link to env var section
  • In the Set environment variables section, expand the env var example to show setting the variables and using them in a request
  • Reduce the number of tip boxes on the page
• Revise some of the Webhook component content per some suggestions in Improved webhook integration guide #7715
  • In components-data#webhook, rewrite the explanation of the snippet, link to the webhook trigger page, and revise the optional troubleshoot/test procedure (this creates a mini flow exclusively for testing the webhook + parser components)
  • Rewrite the webhook trigger page for clarity and to explain the benefits of webhook triggers.
• Remove a redundant, misplaced sentence on api-build.md

Summary by CodeRabbit

• Documentation
  • Improved clarity, structure, and practical guidance across multiple API reference pages.
  • Enhanced and expanded documentation for the Webhook component, including detailed setup steps, troubleshooting, and real-world use cases.
  • Updated API examples and authentication instructions, emphasizing environment variable usage and best practices.
  • Added links to related resources for further information.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This update revises and expands documentation across several API reference and component guide files. Changes include clarifications, improved examples, expanded step-by-step instructions, reworded sections for clarity, and enhanced guidance on authentication, environment variables, and webhook usage. No code or API signatures are modified.

Changes

File(s)	Change Summary
docs/docs/API-Reference/api-build.md	Adjusted placement of a sentence describing parameters for the /build/$FLOW_ID/flow endpoint; no content or parameter changes.
docs/docs/API-Reference/api-flows-run.md	Revised and clarified documentation for the /run endpoint: fixed typos, restructured explanations, updated curl examples, improved streaming section, and simplified example formatting.
docs/docs/API-Reference/api-reference-api-examples.md	Expanded with explicit curl examples, clarified authentication and environment variable usage, and improved practical guidance for API requests.
docs/docs/Components/components-data.md	Updated Webhook component documentation: clarified description, added troubleshooting steps, expanded testing guide, and referenced dedicated webhook documentation.
docs/docs/Develop/webhook.md	Completely rewrote and expanded Webhook component guide: added conceptual overview, detailed configuration and troubleshooting, improved examples, and reorganized content for clarity.

Sequence Diagram(s)

No sequence diagram generated as changes are limited to documentation content and do not affect control flow or introduce new features.

Possibly related PRs

• docs: Separate monolithic API examples page, and add getting started with the Langflow API #8658: Adds a new comprehensive API documentation page for the /build endpoints, which relates to the adjustment of endpoint documentation in this PR.

Suggested labels

documentation, size:M, lgtm

Suggested reviewers

• rodrigosnader
• ogabrielluiz
• mendonk

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix-docs-04-jul-25

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

[github-actions]

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

[github-actions]

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

[github-actions]

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

[mendonk]

+1

[github-actions]

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft