View as Markdown
Signaturely icon

Signaturely ACTION

Create Signature Request

Creates a new signature request. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Signaturely account once, then configure and run Create 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: "signaturely-create-signature-request",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    signaturely: { authProvisionId: "apn_xxxxxxx" },
    templateId: "Template ID",
    signers: ["Signers"],
  },
})

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 Signature Request inputs
Property Type Description
templateId Template ID string
The ID of the template
Required Dynamic
signers Signers string[]
The list of signers for the document. For ordered documents must defined order. fields is an optional dictionary with values for document fields with API tags. The JSON structure for each row is: { "name": "John Doe", "email": "jd@test.com", "role": "test", "order": 1, "fields": { "field1": "value1", "field2": "value2" } }
Required
title Document Title string
The title of the document
Optional
message Document Message string
The message of the document
Optional
isOrdered Document Ordered Flag boolean
Flag indicating if the document is ordered
Optional
testMode Test Mode boolean
Flag indicating if the request is a test
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
signaturely-create-signature-request
Version
0.0.2
App
Signaturely
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes