Native triggers docs

[dannyroosevelt]

WHY

Summary by CodeRabbit

• Documentation
  • Updated Connect API documentation to consistently use the term deployed_trigger_id for deployed triggers, replacing previous terms and clarifying example requests and parameter descriptions.
  • Added an informational callout with links to supported trigger types and example payloads above the "Deploy a trigger" section.
  • Introduced a new section detailing "Deploying triggers," including explanations and examples for app-based event sources and native triggers (HTTP Webhook, Schedule, New emails received), with sample API requests and responses.

[coderabbitai]

Walkthrough

The updates are focused on documentation improvements for the Connect API and component triggers. In the API documentation, all references to the path parameter and variable name for deployed triggers have been standardized from dcid or deployed_component_id to deployed_trigger_id. This affects endpoint paths, parameter descriptions, code samples, and curl examples. Additionally, a callout with links to more information about trigger types and payloads was added. Separately, a new section on "Deploying triggers" was introduced, detailing the differences between app-based event sources and native triggers, with step-by-step examples for deploying native triggers using both Node.js and HTTP.

Changes

File(s)	Summary of Changes
docs-v2/pages/connect/api.mdx	Renamed all instances of dcid/deployed_component_id to deployed_trigger_id in endpoint paths, parameters, and code samples. Added an informational callout above the "Deploy a trigger" section with links to more resources.
docs-v2/pages/connect/components.mdx	Added a new "Deploying triggers" section, categorizing trigger types and providing detailed examples for deploying native triggers (HTTP Webhook, Schedule, New emails received) with both Node.js and HTTP (curl) code samples and example responses.

Poem

In the docs, a tidy sweep,
Trigger names now run so deep.
From dcid to the new ID,
Clarity for all to see!
With native triggers, code in hand—
Deploy with ease, just as planned.
🐇✨ Docs refreshed, let’s hop and cheer,
For clearer guides are now right here!

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

• We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7ddb081 and 50718ec.

📒 Files selected for processing (2)

• docs-v2/pages/connect/api.mdx (15 hunks)
• docs-v2/pages/connect/components.mdx (1 hunks)

🔇 Additional comments (3)

docs-v2/pages/connect/api.mdx (2)

2014-2016: Excellent addition of informational callout and cross-linking.

The new callout linking to supported trigger types and example payloads improves discoverability and user experience.

---

2499-2507: Consistent terminology for deployed triggers.

All references to deployed trigger identifiers have been standardized to deployed_trigger_id, improving clarity and reducing confusion for API users. Examples and parameter descriptions are now consistent throughout the documentation.

Also applies to: 2684-2692, 2794-2802, 2991-2999, 3112-3120, 3251-3259, 3373-3381

docs-v2/pages/connect/components.mdx (1)

815-992: Comprehensive and clear documentation for deploying native triggers.

The new "Deploying triggers" section provides clear, actionable guidance for both app-based and native triggers, with well-structured examples and responses. This significantly improves the usability and completeness of the documentation.

---

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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 15, 2025 10:30pm

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
pipedream-docs	⬜️ Ignored (Inspect)			Apr 15, 2025 10:30pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Apr 15, 2025 10:30pm