View as Markdown
Ashby icon

Ashby ACTION

Create Offer

Creates a new offer. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Ashby account once, then configure and run Create Offer 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: "ashby-create-offer",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ashby: { authProvisionId: "apn_xxxxxxx" },
    offerProcessId: "Offer Process ID",
    offerFormId: "Offer Form 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 Offer inputs
Property Type Description
offerProcessId Offer Process ID string
The ID of the offer process associated with the offer you're creating. This ID is included in the response of the offerProcess.start API.
Required
offerFormId Offer Form ID string
The ID of the form associated with the offer. The ID is included in the response of the offer.start API.
Required
fieldSubmissions Field Submissions string[]

Array of field submission objects. Each object should contain:

  • path (string, required): The form field's "path" value
  • value (string, required): The field value (can be a primitive or complex type depending on field type)

You can find these referebce values in the response of the offer.start API.

Each item can be a JSON string or object with the structure:

[
  {
    "path": "96377e55-cd34-49e2-aff0-5870ec102360",
    "value": "2025-11-07"
  },
  {
    "path": "ded2358d-443f-484f-91fa-ec7a13de842b",
    "value": {
      "value": 10000,
      "currencyCode": "USD"
    }
  }
]
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
ashby-create-offer
Version
0.0.4
App
Ashby
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes