View as Markdown
Gorgias icon

Gorgias ACTION

Create Ticket Message

Create a message for a ticket in the Gorgias system. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Gorgias account once, then configure and run Create Ticket Message 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-create-ticket-message",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    gorgias_oauth: { authProvisionId: "apn_xxxxxxx" },
    ticketId: 10,
    fromAgent: true,
  },
})

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.

Create Ticket Message inputs
Property Type Description
ticketId Ticket ID integer
The ID of the ticket to add a message to
Required Dynamic
fromAgent From Agent boolean
Whether the message was sent by your company to a customer, or the opposite
Required
fromUser From User integer
User who sent the message
Required Dynamic
toUser To User integer
The user receiving the message
Required Dynamic
fromCustomer From Customer integer
The customer who sent the message
Required Dynamic
toCustomer To Customer integer
The customer receiving the message
Required Dynamic
message Message string
Message of the ticket. Accepts HTML
Required
fromAddress From Address (override) string
If set, used as source.from.address instead of looking up the From User/Customer's email. Useful when sending on behalf of a shared inbox (e.g. support@example.com).
Optional
fromName From Name (override) string
Optional display name for source.from.
Optional
toAddress To Address (override) string
If set, used as source.to[0].address instead of looking up the To User/Customer's email.
Optional
toName To Name (override) string
Optional display name for source.to[0].
Optional
channel Channel string
The channel used to send the message. Defaults to email
Required
via Via string
How the message has been received, or sent from Gorgias. Defaults to help-center
Required
sourceType Source Type string
How the message was sent or received. E.g. whatsapp-message, email
Optional
subject Subject string
The subject of the ticket
Optional
attachmentUrl Attachment URL string
The URL to access to the attached file
Optional
attachmentName Attachment File Name string
The name of the file to attach
Optional
sentDatetime Sent Datetime string
When the message was sent. If ommited, the message will be sent by Gorgias. 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-create-ticket-message
Version
0.2.1
App
Gorgias
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes