View as Markdown
Stiply icon

Stiply ACTION

Send Sign Request

Send a sign request to a recipient. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Stiply account once, then configure and run Send Sign 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: "stiply-send-sign-request",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    stiply: { authProvisionId: "apn_xxxxxxx" },
    title: "Title",
    fileUrls: ["File URLs"],
  },
})

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 Sign Request inputs
Property Type Description
title Title string
The title of the sign request
Required
fileUrls File URLs string[]
The URLs of the files to be signed
Required
signers Signers string[]
An array of objects representing the signers of the sign request. Example: [{ "email": "test@example.com", "name": "John Doe" }]. See the documentation for more information about signer properties.
Required
subject Subject string
The subject of the e-mail to the signers
Optional
message Message string
The message to the signers. The message can have some basic HTML tags.
Optional
signingSequenceType Signing Sequence Type string
Choose if all signers can sign in parallel or sequential
Optional
term Term string
2 digit code representing the sign term (1d = one day, 2w = two weeks, 3m = three months). When omitted, the account's configured default term will be used.
Optional
externalKey External Key string
A key for your internal use so you don't have to save the Stiply sign request key in your local database. However, your external key has to be unique.
Optional
comment Comment string
A comment for internal use
Optional
callbackUrl Callback URL string
An URL to be called by Stiply when the last signer has signed the document. Please note that key={sign_request_key},external_key={external_key} and sign_request_id={sign_request_id} shall be added to the call back url querystring. The URL will be called using a GET request. When the callback responses with an error status code, the callback is retried 12 times using an exponential backoff algorithm.
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
stiply-send-sign-request
Version
0.0.3
App
Stiply
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes