View as Markdown
Gorgias icon

Gorgias ACTION

Send Internal Note

Post an internal note to a ticket on behalf of an agent. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Gorgias account once, then configure and run Send Internal Note from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "gorgias_oauth-send-internal-note",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    gorgias_oauth: { authProvisionId: "apn_xxxxxxx" },
    ticketId: 10,
    fromUser: 10,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Send Internal Note inputs
Property Type Description
ticketId Ticket ID integer
The ID of a ticket
Required Dynamic
fromUser From Agent integer
The agent posting the internal note
Required Dynamic
message Message string
Body of the internal note. Accepts HTML
Required
attachmentUrl Attachment URL string
URL of the file to attach
Optional
attachmentName Attachment File Name string
File name for the attachment. Required when Attachment URL is set
Optional
sentDatetime Sent Datetime string
When the message was sent. If omitted, Gorgias sets it automatically. E.g. 2025-01-27T19:38:52.028Z
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
gorgias_oauth-send-internal-note
Version
0.0.4
App
Gorgias
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes