Skip to content

Helpscout new components #17637

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

Helpscout new components #17637

wants to merge 9 commits into from

Conversation

GTFalcao
Copy link
Collaborator

@GTFalcao GTFalcao commented Jul 16, 2025

Closes #17431

Summary by CodeRabbit

  • New Features

    • Added the ability to retrieve detailed information about a specific Help Scout conversation.
    • Introduced an action to fetch all threads for a given Help Scout conversation.
    • Added a real-time event source that emits notifications when a conversation's status is updated in Help Scout.
  • Chores

    • Updated the Help Scout integration package version and dependencies.
    • Incremented version numbers for several Help Scout actions and event sources.

Copy link

vercel bot commented Jul 16, 2025

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) Visit Preview Jul 18, 2025 7:50pm
pipedream-docs ⬜️ Ignored (Inspect) Jul 18, 2025 7:50pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Jul 18, 2025 7:50pm

Copy link
Contributor

coderabbitai bot commented Jul 16, 2025

Walkthrough

New Help Scout integration features were added, including actions to fetch conversation details and threads, and a source to emit events when a conversation's status is updated. Supporting API methods were implemented, a test event fixture was introduced, and the package version and dependencies were updated.

Changes

Files/Paths Change Summary
components/help_scout/actions/get-conversation-details/...
components/help_scout/actions/get-conversation-threads/...
Added actions to fetch conversation details and conversation threads using Help Scout API.
components/help_scout/help_scout.app.mjs Added getConversation and getConversationThreads methods for API requests.
components/help_scout/sources/conversation-status-updated-instant/... Added a new source to emit events when a conversation status is updated, with summary and event typing.
components/help_scout/sources/conversation-status-updated-instant/test-event.mjs Added a test event fixture representing a conversation status update event.
components/help_scout/package.json Updated package version and upgraded @pipedream/platform dependency.
components/help_scout/actions/add-note/add-note.mjs
components/help_scout/actions/create-customer/create-customer.mjs
components/help_scout/actions/send-reply/send-reply.mjs
components/help_scout/sources/new-agent-reply-instant/new-agent-reply-instant.mjs
components/help_scout/sources/new-conversation-created-instant/new-conversation-created-instant.mjs
components/help_scout/sources/new-customer-instant/new-customer-instant.mjs
components/help_scout/sources/new-customer-reply-instant/new-customer-reply-instant.mjs
components/help_scout/sources/new-note-created-instant/new-note-created-instant.mjs
components/help_scout/sources/new-conversation-assigned-instant/new-conversation-assigned-instant.mjs
Version bumps only for existing actions and sources.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Action
    participant HelpScoutApp
    participant HelpScoutAPI

    User->>Action: Trigger "Get Conversation Details"
    Action->>HelpScoutApp: getConversation({conversationId, embed})
    HelpScoutApp->>HelpScoutAPI: GET /conversations/{conversationId}
    HelpScoutAPI-->>HelpScoutApp: Conversation details
    HelpScoutApp-->>Action: Return details
    Action-->>User: Output conversation details
Loading
sequenceDiagram
    participant User
    participant Action
    participant HelpScoutApp
    participant HelpScoutAPI

    User->>Action: Trigger "Get Conversation Threads"
    Action->>HelpScoutApp: getConversationThreads({conversationId, page})
    HelpScoutApp->>HelpScoutAPI: GET /conversations/{conversationId}/threads?page={page}
    HelpScoutAPI-->>HelpScoutApp: Threads data with pagination
    HelpScoutApp-->>Action: Return threads and pagination
    Action-->>User: Output threads list
Loading
sequenceDiagram
    participant HelpScoutWebhook
    participant Source
    participant User

    HelpScoutWebhook->>Source: Send "convo.status" event
    Source->>User: Emit event with summary and payload
Loading

Assessment against linked issues

Objective Addressed Explanation
Implement actions to fetch conversation details and conversation threads (#17431)
Implement source to emit event on conversation status change (#17431)
Add corresponding API methods for fetching conversations and threads (#17431)
Version bumps for existing actions and sources as part of maintenance (#17431)

Assessment against linked issues: Out-of-scope changes

Code Change Explanation
Version number updates in multiple existing actions and sources (e.g., add-note.mjs, send-reply.mjs) These changes are maintenance/version increments and do not relate directly to new feature objectives.

Poem

🐇 A hop, a leap, a status change—
Conversations fetched, both details and range.
Threads unraveled, events now near,
Help Scout’s voice is crystal clear!
With every update, a rabbit’s cheer—
New features bloom, the path ahead is dear.
(づ。◕‿‿◕。)づ

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

components/help_scout/actions/get-conversation-details/get-conversation-details.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9)
at packageResolve (node:internal/modules/esm/resolve:767:81)
at moduleResolve (node:internal/modules/esm/resolve:853:18)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38)
at #link (node:internal/modules/esm/module_job:202:49)


📜 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 2320d5b and 54d8b9a.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (1)
  • components/help_scout/actions/get-conversation-details/get-conversation-details.mjs (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • components/help_scout/actions/get-conversation-details/get-conversation-details.mjs
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Lint Code Base
  • GitHub Check: Publish TypeScript components
  • GitHub Check: Verify TypeScript components
✨ Finishing Touches
  • 📝 Generate Docstrings

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

Comment on lines 19 to 22
const response = (await this.helpScout.getConversationThreads({
$,
conversationId: this.conversationId,
}))?._embedded?.threads;
Copy link
Collaborator

Choose a reason for hiding this comment

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

It looks from the docs like maybe this can be paginated? If so, we should offer a maxResults prop and return a paginated list.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good call - it seems the Helpscout API only supports passing a 'page' parameter though, and the page size for this endpoint is fixed at 25 entries. I've added a 'page' prop with this information so users can retrieve older entries if needed

luancazarine
luancazarine previously approved these changes Jul 17, 2025
Copy link
Collaborator

@luancazarine luancazarine left a comment

Choose a reason for hiding this comment

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

Hi @GTFalcao, LGTM! Ready for QA!

@GTFalcao
Copy link
Collaborator Author

/approve

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.

Helpscout
3 participants