View as Markdown
Pipeline icon

Pipeline ACTION

Create Deal

Creates a new deal in your Pipeline account. See the docs here
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Pipeline account once, then configure and run Create Deal 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: "pipeline-create-deal",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    pipeline: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    userId: "User ID",
  },
})

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 Deal inputs
Property Type Description
name Name string
The name of the deal
Required
userId User ID string
The identifier of a user
Optional Dynamic
primaryContactId Person ID string
The identifier of a person
Optional Dynamic
dealStatusId Deal Status ID string
The identifier of a deal status
Optional Dynamic
dealStageId Deal Stage ID string
The identifier of a deal stage
Optional Dynamic
summary Summary string
Explanatory or descriptive text about the deal
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
pipeline-create-deal
Version
0.0.2
App
Pipeline
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes