View as Markdown
Ashby icon

Ashby ACTION

Start Offer

Starts an offer and returns an offer form instance that can be filled out and submitted. 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 Start 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-start-offer",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ashby: { authProvisionId: "apn_xxxxxxx" },
    offerProcessId: "Offer Process 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.

Start 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

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-start-offer
Version
0.0.4
App
Ashby
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes