View as Markdown
Spondyr icon

Spondyr ACTION

Create Spondyr

Generate and optionally deliver correspondence. See the docs here
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Spondyr account once, then configure and run Create Spondyr 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: "spondyr-create-spondyr",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    spondyr: { authProvisionId: "apn_xxxxxxx" },
    transactionType: "Transaction Type",
    eventType: "Event Type",
  },
})

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 Spondyr inputs
Property Type Description
transactionType Transaction Type string
The Spondyr Transaction Type
Required Dynamic
eventType Event Type string
The Spondyr Event Type
Required Dynamic
isGenerateOnly Is Generate Only boolean
Set this flag to true to pause/defer delivery until a followup call is made via the Deliver API. This is useful for scenarios where you wish to view/preview the generated correspondence and validate things before allowing the correspondence to be delivered.
Optional
data Data object
It should contain your application's specific data, which should be in the same format as you defined for the Transaction Type
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
spondyr-create-spondyr
Version
0.0.4
App
Spondyr
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes