View as Markdown
OnlineCheckWriter icon

OnlineCheckWriter ACTION

Create Email Check

Create an email check for a payee. 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 Create Email Check 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-create-email-check",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    onlinecheckwriter: { authProvisionId: "apn_xxxxxxx" },
    checkId: "Check ID",
    payeeEmail: "Payee Email",
  },
})

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 Email Check inputs
Property Type Description
checkId Check ID string
Must be a check ID.
Required Dynamic
payeeEmail Payee Email string
The email address of the payee.
Required
enableSmsInform Enable SMS Inform boolean
Value is true if SMS inform is enabled. Default false
Optional
payeePhone Payee Phone string
Required if Enable SMS Inform is true and not exist any phone on associated payee,
Required
sendAttachment Send Attachment boolean
This will send added attachments along with the check.
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-create-email-check
Version
0.0.2
App
OnlineCheckWriter
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes