View as Markdown
Lumin PDF icon

Lumin PDF ACTION

Send Signature Request

Send a signature request to signers. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Lumin PDF account once, then configure and run Send Signature Request 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: "lumin_pdf-send-signature-request",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    lumin_pdf: { authProvisionId: "apn_xxxxxxx" },
    fileUrl: "File URL",
    file: "File",
  },
})

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.

Send Signature Request inputs
Property Type Description
fileUrl File URL string
The URL of a single file to be downloaded and signed. This field is mutually exclusive with file, files, and File URLs. Only one of these fields should be provided in the request.
Optional
file File string
A single path to a file in the /tmp directory (for example, /tmp/myFile.pdf) to be sent for signature. This field is mutually exclusive with File URL, Files, and File URLs. Only one of these fields should be provided in the request.
Optional
fileUrls File URLs string[]
An array of URLs of files to be downloaded and signed. This field is mutually exclusive with File, Files, and File URL. Only one of these fields should be provided in the request.
Optional
files Files string[]
An array of path to files in the /tmp directory (for example, /tmp/myFile.pdf) to be sent for signature. This field is mutually exclusive with File URL, Files, and File URLs. Only one of these fields should be provided in the request.
Optional
signers Signers string[]
A list of objects of signers to add to your Signature Request. Format: [{'email_address': 'email@example.com', 'name': 'John Doe', 'group': 1}, {'email_address': 'email2@example.com', 'name': 'Jane Doe', 'group': 2}]. See the documentation for more information.
Optional
viewers Viewers string[]
A list of objects of viewers to add to your Signature Request. Format: [{'email_address': 'email@example.com', 'name': 'John Doe'}, {'email_address': 'email2@example.com', 'name': 'Jane Doe'}]. See the documentation for more information.
Optional
title Title string
The title you want to give the Signature Request.
Required
expiresAt Expires At string
When the Signature Request will expire. Should be later than today. In ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
Required
useTextTags Use Text Tags boolean
Set to true to enable Text Tag parsing in your document. Your Text Tags will be converted into UI components for the user to interact with.
Optional
signingType Signing Type string
The signing order for the Signature Request.
Optional
senderEmail Sender Email string
The email address of the sender.
Optional
subject Subject string
The subject of the email.
Optional
customEmailTitle Custom Email Title string
The title of the email.
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
lumin_pdf-send-signature-request
Version
0.0.4
App
Lumin PDF
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes