View as Markdown
OnlineCheckWriter icon

OnlineCheckWriter ACTION

Mail PDF Document

Mails a PDF document to a destination. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's OnlineCheckWriter account once, then configure and run Mail PDF Document 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: "onlinecheckwriter-mail-pdf-document",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    onlinecheckwriter: { authProvisionId: "apn_xxxxxxx" },
    documentTitle: "Document Title",
    filePath: "File Path or URL",
  },
})

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.

Mail PDF Document inputs
Property Type Description
documentTitle Document Title string
The title of the document.
Optional
filePath File Path or URL string
The PDF file to upload. Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFile.pdf)
Required
shippingTypeId Shipping Type ID string
Must be a valid shipping type ID.
Required
senderName Sender Name string
The name of the sender.
Optional
senderCompany Sender Company string
The company of the sender.
Optional
senderAddress1 Sender Address 1 string
The first line of the sender's address.
Optional
senderAddress2 Sender Address 2 string
The second line of the sender's address.
Optional
senderCity Sender City string
The city of the sender.
Optional
senderState Sender State string
The state of the sender.
Optional
senderZip Sender Zip string
The zip code of the sender.
Optional
senderPhone Sender Phone string
The phone number of the sender.
Optional
senderEmail Sender Email string
The email address of the sender.
Optional
destinationName Destination Name string
The name of the recipient.
Required
destinationCompany Destination Company string
The company of the recipient.
Optional
destinationAddress1 Destination Address 1 string
The first line of the recipient's address.
Required
destinationAddress2 Destination Address 2 string
The second line of the recipient's address.
Optional
destinationCity Destination City string
The city of the recipient.
Required
destinationState Destination State string
The state of the recipient. Use 2 characters Eg. Tx instead of Texas for example.
Required
destinationZip Destination Zip string
The zip code of the recipient.
Required
destinationPhone Destination Phone string
The phone number of the recipient.
Optional
destinationEmail Destination Email string
The email address of the recipient.
Optional
syncDir SyncDir dir
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
onlinecheckwriter-mail-pdf-document
Version
0.1.3
App
OnlineCheckWriter
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes