SegMetrics ACTION
Create Or Update Order
Creates a client. See documentation here
- Action
- Writes data
- Destructive
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's SegMetrics account once, then configure and run Create Or Update Order 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: "segmetrics-create-or-update-order",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
segmetrics: { authProvisionId: "apn_xxxxxxx" },
integrationId: "Integration ID",
invoiceId: "Invoice ID",
},
})
console.log(result)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": "segmetrics-create-or-update-order",
"configured_props": {
"segmetrics": { "authProvisionId": "apn_xxxxxxx" },
"integrationId": "Integration ID",
"invoiceId": "Invoice ID"
}
}'// 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": "segmetrics",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "segmetrics-create-or-update-order",
arguments: {
integrationId: "Integration ID",
invoiceId: "Invoice ID",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
integrationId Integration ID | string | The ID of the integration from your Account Settings Page Required |
invoiceId Invoice ID | string | Unique identifier for the invoice Required |
email Contact's Email | string | Email address of the contact Required |
amount Invoice Total in Cents | integer | Total amount of the invoice in cents Required |
paid Invoice Amount Paid in Cents | integer | Amount paid for the invoice in cents Required |
dateCreated Invoice Date | string | Date when the invoice was created. E.g 2018-10-03 11:14:32 Required |
items Array of Invoice Items | string | An array containing details of individual items within the invoice. E.g. [ { "name": "Round Tuit", "product_id": 1556402307145, "amount": 4000, "total_paid": 4000 } ] Required |
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
- segmetrics-create-or-update-order
- Version
- 0.0.4
- App
- SegMetrics
- Authentication
- API key
- Read-only
- No
- Destructive
- Yes
- Open world
- Yes
- Source
- View on GitHub ↗