Add internal notes support to Gorgias OAuth integration #17605

seynadio · 2025-07-14T11:32:44Z

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, including a new "internal-note" channel option.
- Introduced a new event source that emits events when internal notes are created on tickets, with optional filtering by ticket ID and sender email.
Enhancements
- Improved message creation by adjusting prop visibility and validation logic based on the selected channel.
- Added helper methods for handling attachments and retrieving email addresses.
Chores
- Updated package version to reflect recent changes.

- 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 - Update package.json version

vercel · 2025-07-14T11:32:50Z

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

A member of the Team first needs to authorize it.

vercel · 2025-07-14T11:32:52Z

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 14, 2025 11:32am

coderabbitai · 2025-07-14T11:32:52Z

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 `channel` prop, new helper methods, and logic for "internal-note" channel in message creation.
components/gorgias_oauth/sources/internal-note-created/internal-note-created.mjs	Introduced new source component to emit events for internal note creation.
components/gorgias_oauth/sources/internal-note-created/test-event.mjs	Added sample test event data for internal note creation.
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)

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

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)

components/gorgias_oauth/sources/internal-note-created/test-event.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 e21d334 and 9712039.

📒 Files selected for processing (4)

components/gorgias_oauth/actions/create-ticket-message/create-ticket-message.mjs (6 hunks)
components/gorgias_oauth/package.json (1 hunks)
components/gorgias_oauth/sources/internal-note-created/internal-note-created.mjs (1 hunks)
components/gorgias_oauth/sources/internal-note-created/test-event.mjs (1 hunks)

🧰 Additional context used

🧠 Learnings (5)

📓 Common learnings

Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#15376
File: components/monday/sources/name-updated/name-updated.mjs:6-6
Timestamp: 2025-01-23T03:55:15.166Z
Learning: Source names in Monday.com components don't need to start with "New" if they emit events for updated items (e.g., "Name Updated", "Column Value Updated") rather than new items. This follows the component guidelines exception where the "New" prefix is only required when emits are limited to new items.

components/gorgias_oauth/package.json (1)

Learnt from: jcortes
PR: PipedreamHQ/pipedream#14935
File: components/sailpoint/package.json:15-18
Timestamp: 2024-12-12T19:23:09.039Z
Learning: When developing Pipedream components, do not add built-in Node.js modules like `fs` to `package.json` dependencies, as they are native modules provided by the Node.js runtime.

components/gorgias_oauth/sources/internal-note-created/test-event.mjs (1)

Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#14265
File: components/the_magic_drip/sources/common.mjs:35-43
Timestamp: 2024-10-10T19:18:27.998Z
Learning: In `components/the_magic_drip/sources/common.mjs`, when processing items in `getAndProcessData`, `savedIds` is intentionally updated with IDs of both emitted and non-emitted items to avoid emitting retroactive events upon first deployment and ensure only new events are emitted as they occur.

components/gorgias_oauth/actions/create-ticket-message/create-ticket-message.mjs (3)

Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12731
File: components/hackerone/actions/get-members/get-members.mjs:3-28
Timestamp: 2024-10-08T15:33:38.240Z
Learning: When exporting a summary message in the `run` method of an action, ensure the message is correctly formatted. For example, in the `hackerone-get-members` action, the correct format is `Successfully retrieved ${response.data.length} members`.

Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12731
File: components/hackerone/actions/get-members/get-members.mjs:3-28
Timestamp: 2024-07-04T18:11:59.822Z
Learning: When exporting a summary message in the `run` method of an action, ensure the message is correctly formatted. For example, in the `hackerone-get-members` action, the correct format is `Successfully retrieved ${response.data.length} members`.

Learnt from: jcortes
PR: PipedreamHQ/pipedream#14467
File: components/gainsight_px/actions/create-account/create-account.mjs:4-6
Timestamp: 2024-10-30T15:24:39.294Z
Learning: In `components/gainsight_px/actions/create-account/create-account.mjs`, the action name should be "Create Account" instead of "Create Memory".

components/gorgias_oauth/sources/internal-note-created/internal-note-created.mjs (2)

Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#15376
File: components/monday/sources/name-updated/name-updated.mjs:6-6
Timestamp: 2025-01-23T03:55:15.166Z
Learning: Source names in Monday.com components don't need to start with "New" if they emit events for updated items (e.g., "Name Updated", "Column Value Updated") rather than new items. This follows the component guidelines exception where the "New" prefix is only required when emits are limited to new items.

Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#14265
File: components/the_magic_drip/sources/common.mjs:35-43
Timestamp: 2024-10-10T19:18:27.998Z
Learning: In `components/the_magic_drip/sources/common.mjs`, when processing items in `getAndProcessData`, `savedIds` is intentionally updated with IDs of both emitted and non-emitted items to avoid emitting retroactive events upon first deployment and ensure only new events are emitted as they occur.

🔇 Additional comments (9)

components/gorgias_oauth/package.json (1)

3-3: Version bump looks good.

The version increment from 0.5.1 to 0.5.2 is appropriate for the new internal notes functionality being added.

components/gorgias_oauth/sources/internal-note-created/test-event.mjs (1)

1-43: Well-structured test event for internal notes.

The test event correctly models an internal note with appropriate fields:

channel and via set to "internal-note"

public: false for internal visibility

receiver: null as internal notes don't have external recipients

Includes all necessary fields for comprehensive testing

components/gorgias_oauth/sources/internal-note-created/internal-note-created.mjs (1)

1-63: Solid implementation of the internal note webhook source.

The component is well-structured with:

Appropriate filtering logic using optional ticketId and sender props

Correct use of optional chaining in isRelevant method

Clear JSDoc documentation on all methods

Proper event emission logic

components/gorgias_oauth/actions/create-ticket-message/create-ticket-message.mjs (6)

70-78: Good addition of the channel prop.

The channel prop is properly configured with:

Required field with sensible default value ("email")

reloadProps: true to update the UI when channel changes

Proper integration with the propDefinition

113-117: Clean conditional prop visibility logic.

The updated logic correctly hides sender/receiver fields when creating internal notes, providing a cleaner user experience.

121-165: Well-documented helper methods.

Both getAttachmentInfo and getEmail methods are properly implemented with clear JSDoc documentation. The getEmail method correctly handles the different scenarios for agent/customer messages.

173-202: Appropriate validation handling for internal notes.

The conditional validation correctly skips from/to validation for internal notes while maintaining proper validation for other message types.

204-239: Clean message data construction.

The refactored approach using messageData object with conditional addition of source, sender, and receiver fields for non-internal notes is well-structured and maintainable.

247-247: Clear and informative summary message.

The updated summary correctly indicates whether an internal note or ticket message was created.

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

pipedream-component-development · 2025-07-14T11:33:01Z

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 · 2025-07-14T11:33:02Z

adolfo-pd added the User submitted Submitted by a user label Jul 14, 2025

seynadio mentioned this pull request Jul 14, 2025

Gorgias internal notes #17599

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add internal notes support to Gorgias OAuth integration #17605

Add internal notes support to Gorgias OAuth integration #17605

Uh oh!

seynadio commented Jul 14, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Jul 14, 2025

Uh oh!

vercel bot commented Jul 14, 2025

Uh oh!

coderabbitai bot commented Jul 14, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

pipedream-component-development commented Jul 14, 2025

Uh oh!

pipedream-component-development commented Jul 14, 2025

Uh oh!

Uh oh!

Add internal notes support to Gorgias OAuth integration #17605

Are you sure you want to change the base?

Add internal notes support to Gorgias OAuth integration #17605

Uh oh!

Conversation

seynadio commented Jul 14, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Test plan

Summary by CodeRabbit

Uh oh!

vercel bot commented Jul 14, 2025

Uh oh!

vercel bot commented Jul 14, 2025

Uh oh!

coderabbitai bot commented Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

pipedream-component-development commented Jul 14, 2025

Uh oh!

pipedream-component-development commented Jul 14, 2025

Uh oh!

Uh oh!

seynadio commented Jul 14, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 14, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)