DocuSign

Create, list, and send envelopes for e-signatures with DocuSign.

On this page

Connect
Call it from a workflow
Actions (4)
getEnvelope
listEnvelopes
custom_api_call
getDocument
Details

Connect

Auth type: OAuth (oauth2). Click Connect and approve access on the provider's page. Appbricx runs the OAuth flow (signed single-use state, PKCE where the provider supports it), stores the tokens encrypted and refreshes them before they expire.

Scopes requested: signature

OAuth needs an OAuth app: the platform's when the operator configured one, or your own (admin panel, Integrations, Configure). You can also bring your own credentials.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("docusign", "getEnvelope", {
    "accountId": "<account id>",
    "envelopeId": "<envelope id>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("DocuSign answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "docusign-getenvelope",
  name: "DocuSign: Get envelope",
  description: "Calls DocuSign when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("docusign", {
      "action": "getEnvelope",
      "accountId": "<account id>",
      "envelopeId": "<envelope id>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/docusign/getEnvelope" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"accountId":"<account id>","envelopeId":"<envelope id>"}}'

Actions

getEnvelopein catalog

Get envelope. Get Docusign envelope

Input	Type	Description
`accountId`required	text	Account ID
`envelopeId`required	text	Envelope ID

listEnvelopesin catalog

List envelopes. List / search envelopes

Input	Type	Description
`accountId`required	text	Account ID
`fromDate`optional	date-time (ISO)	From date
`toDate`optional	date-time (ISO)	To date
`searchText`optional	text	Search text
`status`optional	text	Status
`include`optional	array	Include (e.g. recipients)

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

getDocument

Get document. Get document from a specific envelope

Input	Type	Description
`accountId`required	text	Account ID
`envelopeId`required	text	Envelope ID
`documentId`required	text	The ID of the document to retrieve. Alternatively, you can use one of the following special keywords: combined: Retrieves all of the documents as a single PDF file. When the query parameter certifica…

Details

Id: docusign
Category: Other
Tags: e-signature, documents, contracts, legal
Package: @activepieces/piece-docusign@0.1.4
Tier: Built in