Add internal notes support to Gorgias OAuth integration

[seynadio]

Summary

• Add channel prop to create-ticket-message action with internal-note support
• Add conditional logic to skip sender/receiver validation for internal notes
• Create internal-note-created webhook source for monitoring internal note events
• Add JSDoc documentation to all methods

Changes

• create-ticket-message.mjs: Enhanced to support channel="internal-note" with conditional validation
• internal-note-created.mjs: New webhook source that filters for internal note events
• test-event.mjs: Sample event data for internal notes
• package.json: Version bump

Test plan

• Test creating internal notes via the action
• Test webhook source receives internal note events correctly
• Add JSDoc documentation for code quality
• Remove Freshdesk changes that were accidentally included in original PR

Summary by CodeRabbit

• New Features
  • Added support for creating internal notes on tickets with a new "internal-note" channel option.
  • Introduced an event source that emits events when internal notes are created, supporting optional filtering by ticket ID and sender email.
• Enhancements
  • Adjusted message creation logic to modify prop visibility and validation based on the channel.
  • Added helper methods for fetching attachment details and retrieving email addresses.
• Chores
  • Updated package version to 0.5.2.

[vercel]

@seynadio is attempting to deploy a commit to the Pipedreamers Team on Vercel.

A member of the Team first needs to authorize it.

[vercel]

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

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Jul 21, 2025 7:54am

[coderabbitai]

Walkthrough

The changes introduce support for handling "internal-note" messages in the Gorgias OAuth integration. A new source component emits events when internal notes are created, and the ticket message action is updated to handle the "internal-note" channel, affecting prop visibility, validation, and message payload structure. Package versions are incremented accordingly.

Changes

File(s)	Change Summary
components/gorgias_oauth/actions/create-ticket-message/create-ticket-message.mjs	Added required channel prop (default "email"), helper methods getAttachmentInfo and getEmail, updated visibility, validation, and message payload logic for "internal-note" channel.
components/gorgias_oauth/sources/internal-note-created/internal-note-created.mjs	Added new source component emitting events on internal note creation with optional filters for ticket ID and sender.
components/gorgias_oauth/sources/internal-note-created/test-event.mjs	Added sample test event data representing an internal note creation event.
components/gorgias_oauth/package.json	Bumped package version from 0.5.1 to 0.5.2.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Action (Create Ticket Message)
    participant Gorgias API

    User->>Action (Create Ticket Message): Provide message details (with channel)
    alt channel == "internal-note"
        Action (Create Ticket Message)->>Gorgias API: Create message (channel: internal-note, minimal payload)
    else channel != "internal-note"
        Action (Create Ticket Message)->>Gorgias API: Create message (full payload)
    end
    Gorgias API-->>Action (Create Ticket Message): Confirmation
    Action (Create Ticket Message)-->>User: Summary (internal note or ticket message created)

Loading

sequenceDiagram
    participant Gorgias API
    participant Source (New Internal Note)
    participant User

    Gorgias API-->>Source (New Internal Note): Event (TICKET_MESSAGE_CREATED, channel: internal-note)
    Source (New Internal Note)->>Source (New Internal Note): Check relevance (ticketId, sender)
    alt Relevant
        Source (New Internal Note)-->>User: Emit internal note event
    else Not relevant
        Source (New Internal Note)-->>User: No event emitted
    end

Loading

Estimated code review effort

File(s)	Effort
components/gorgias_oauth/actions/create-ticket-message/create-ticket-message.mjs	3 (30–60 mins)
components/gorgias_oauth/sources/internal-note-created/internal-note-created.mjs	3 (30–60 mins)
components/gorgias_oauth/sources/internal-note-created/test-event.mjs	1 (<10 mins)
components/gorgias_oauth/package.json	1 (<10 mins)

Poem

In the warren of code, a note hops in,
Internal whispers, where stories begin.
A new event source, fresh and bright,
Tracks agent thoughts out of sight.
With version bumps and helper paws,
This bunny applauds your clever cause! 🐇✨

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/gorgias_oauth/actions/create-ticket-message/create-ticket-message.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)

components/gorgias_oauth/sources/internal-note-created/internal-note-created.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 0c891c0 and 1eb8c05.

📒 Files selected for processing (2)

• components/gorgias_oauth/actions/create-ticket-message/create-ticket-message.mjs (6 hunks)
• components/gorgias_oauth/sources/internal-note-created/internal-note-created.mjs (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• components/gorgias_oauth/sources/internal-note-created/internal-note-created.mjs
• components/gorgias_oauth/actions/create-ticket-message/create-ticket-message.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). (4)

• GitHub Check: pnpm publish
• GitHub Check: Publish TypeScript components
• GitHub Check: Verify TypeScript components
• GitHub Check: Lint Code Base

✨ 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

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

[pipedream-component-development]

Thank you so much for submitting this! We've added it to our backlog to review, and our team has been notified.

[pipedream-component-development]

Thanks for submitting this PR! When we review PRs, we follow the Pipedream component guidelines. If you're not familiar, here's a quick checklist:

• Create components to address specific use cases whenever possible
• Component keys should follow the format app_name_slug-slugified-component-name
• Components should follow the standard directory structure
• Prefer Node.js client libraries to REST APIs
• When making API requests, handle pagination to ensure all data / events are processed
• Use secret props to capture sensitive data
• Props and methods should be defined in app files whenever possible
• Document methods with JS Docs
• Use optional props whenever possible, and set a default value where you can
• Use async options to accept user input wherever possible
• Create subscription webhooks sources (vs polling sources) whenever possible
• Always emit a summary with events
• Use a built-in deduping strategy wherever possible
• When building webhook sources, follow these best practices
• When building polling sources, follow these best practices

[michelle0927]

Thank you for your contribution! LGTM! Ready for QA

[vunguyenhung]

Hello everyone, I have tested this PR and there're some test cases failed or needed improvement.

Please check the test report below for more information
https://vunguyenhung.notion.site/Add-internal-notes-support-to-Gorgias-OAuth-integration-234bf548bb5e8191bb88ea41477a0427

[Afstkla]

Hi @vunguyenhung , just fixed the failing test. Also, would you be so kind as to verify the internal note creation (the new feature that was introduced in this PR) actually works?