CONNECT APP
Build with Gorgias
Commerce
- OAuth
MCP
Give your agent Gorgias tools
Every Gorgias action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Gorgias account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "gorgias_oauth",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Add Ticket Tags:
const result = await mcp.callTool({
name: "gorgias_oauth-add-ticket-tags",
arguments: {
ticketId: 10,
tagIds: ["Tag IDs"],
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "gorgias_oauth",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Add Ticket Tags:
result = await session.call_tool("gorgias_oauth-add-ticket-tags", {
"ticketId": 10,
"tagIds": ["Tag IDs"],
})API PROXY
Call the Gorgias API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Gorgias API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://api.example.com/v1/me",
})
// Any allowed Gorgias endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://api.example.com/v1/me
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuZXhhbXBsZS5jb20vdjEvbWU?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Gorgias actions from your backend
Connect a user's Gorgias account once, then run Add Ticket Tags on their behalf from your own code — TypeScript, Python, or plain HTTP.
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-add-ticket-tags",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
gorgias_oauth: { authProvisionId: "apn_xxxxxxx" },
ticketId: 10,
tagIds: ["Tag IDs"],
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="gorgias_oauth-add-ticket-tags",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"gorgias_oauth": {"authProvisionId": "apn_xxxxxxx"},
"ticketId": 10,
"tagIds": ["Tag IDs"],
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "gorgias_oauth-add-ticket-tags",
"configured_props": {
"gorgias_oauth": { "authProvisionId": "apn_xxxxxxx" },
"ticketId": 10,
"tagIds": ["Tag IDs"]
}
}'TOOLS
Gorgias actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Add Ticket Tags
actionAdd tags to a ticket. See the documentationWritev0.0.4 -
Create Customer
actionCreate a new customer. See the docsWritev0.0.13 -
Create Macro
actionCreate a macro. See the documentationWritev0.0.7 -
Create Ticket
actionCreate a new ticket. See the docsWritev0.0.14 -
Create Ticket Message
actionCreate a message for a ticket in the Gorgias system. See the documentationWritev0.2.1 -
Delete Macro
actionDelete a macro. See the documentationWritev0.0.7 -
Get Macro
actionGet a macro by ID. See the documentationRead-onlyv0.0.4 -
Get Ticket
actionGet a ticket. See the documentationRead-onlyv0.0.7 -
Get Ticket Message
actionGet a specific message from a ticket. See the documentationRead-onlyv0.0.5 -
List Macros
actionList all macros. See the documentationRead-onlyv0.0.7 -
List Messages
actionList all messages. See the documentationRead-onlyv0.0.5 -
List Ticket Field Values
actionList field values for a ticket. See the documentationRead-onlyv0.0.4 -
List Ticket Messages
actionList all messages for a specific ticket. See the documentationRead-onlyv0.0.5 -
List Ticket Tags
actionList tags for a ticket. See the documentationRead-onlyv0.0.4 -
List Tickets
actionList all tickets. See the docsRead-onlyv0.0.14 -
Retrieve a Customer
actionRetrieve a customer. See the docsRead-onlyv0.0.13 -
Send Internal Note
actionPost an internal note to a ticket on behalf of an agent. See the documentationWritev0.0.4 -
Send Public Reply
actionPost a customer-facing reply to a ticket on behalf of an agent. See the documentationWritev0.0.4 -
Set Ticket Tags
actionSet tags on a ticket. See the documentationWritev0.0.4 -
Update Customer
actionUpdate a customer. See the docsWritev0.0.13 -
Update Macro
actionUpdate a macro. See the documentationWritev0.0.7 -
Update Ticket
actionUpdates a predefined ticket in the Gorgias system. See the documentationWritev0.0.10 -
Update Ticket Field Values
actionSet custom field values on a ticket. The connected account's ticket custom fields are exposed as individual optional props. Each field is written on its own request, so re-running after a failure is safe. See the documentationWritev1.0.0
EVENTS
Gorgias triggers
Event sources your backend can deploy for users and receive through a webhook.
-
Macro Updated
triggerEmit new event when a macro is updated. See the documentationv0.0.6 -
New Internal Note
triggerEmit new event when an internal note is created on a ticket. See the documentationInstantv0.0.8 -
New Macro Created
triggerEmit new event when a macro is created. See the documentationv0.0.6 -
New Ticket
triggerEmit new event when a ticket is created. See the documentationInstantv0.2.3 -
New Ticket Message
triggerEmit new event when a ticket message is created. See the documentationInstantv0.1.14 -
New Updated Ticket
triggerEmit new event when a ticket is updated. See the documentationInstantv0.2.3
MULTI-APP
Use Gorgias with other popular apps
Most products don't stop at one integration. Pair Gorgias with the other apps your users rely on, and ship use cases that span both.
- App slug
- gorgias_oauth
- Authentication
- OAuth
- Categories
- Commerce
- Actions
- 23
- Triggers
- 6
- API proxy
- Available
OAuth scopes
These are the scopes Pipedream's managed Gorgias OAuth client requests when one of your users connects an account. Supply your own OAuth client to request a different set.
- openid
- profile
- offline
- write:all