Add webhook_uri to webhook_uri

[bzwrk]

WHY

Summary by CodeRabbit

• New Features

  • Introduced an optional webhook_uri property for enhanced handling of connection events in the SDK.

• Version Updates

  • Updated the version of the @pipedream/sdk package from 0.1.7 to 0.1.8.

[vercel]

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

3 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
docs-v2	⬜️ Ignored (Inspect)			Oct 14, 2024 9:24pm
pipedream-docs	⬜️ Ignored (Inspect)			Oct 14, 2024 9:24pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Oct 14, 2024 9:24pm

[linear]

DJ-2550 Update sdk with webhook uri

[coderabbitai]

Walkthrough

The pull request introduces two primary changes: it updates the version number of the @pipedream/sdk package from 0.1.7 to 0.1.8 in the package.json file, and it adds a new optional property webhook_uri to the ConnectTokenCreateOpts type in the index.ts file. The new property allows for the specification of a webhook URI for connection event handling, while no other changes to existing structures or functionalities are made.

Changes

File Path	Change Summary
packages/sdk/package.json	Updated version from 0.1.7 to 0.1.8.
packages/sdk/src/server/index.ts	Added optional property webhook_uri?: string to ConnectTokenCreateOpts type.

Possibly related PRs

• update types for hosted link #14113: This PR adds optional properties to the ConnectTokenCreateOpts type in the same file (packages/sdk/src/server/index.ts) where the webhook_uri property was added in the main PR, indicating a related enhancement to the type structure.

Suggested labels

enhancement, dependencies, pd-api, javascript, prioritized, strategic-app

Suggested reviewers

• dylburger

🐇 In the meadow, changes bloom,
A version rise, dispelling gloom.
A webhook here, a token's friend,
Connections thrive, on this we depend!
With every hop, our code takes flight,
Enhancements made, all feels just right! 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 29c4dcd and 0068561.

📒 Files selected for processing (2)

• packages/sdk/package.json (1 hunks)
• packages/sdk/src/server/index.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• packages/sdk/package.json

🧰 Additional context used

🔇 Additional comments (1)

packages/sdk/src/server/index.ts (1)

59-63: LGTM: New webhook_uri property added to ConnectTokenCreateOpts

The addition of the webhook_uri property to the ConnectTokenCreateOpts type is a good enhancement. It allows for specifying a webhook URI that Pipedream can invoke on success or failure of connection requests, which can improve the flexibility of the connection process.

To ensure this change is properly integrated, let's verify if the connectTokenCreate method handles this new property correctly:

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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