← Docusign

Download Documents with Docusign API

Pipedream makes it easy to connect APIs for Docusign and 2,400+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Download Documents with the Docusign API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Download Documents with the Docusign API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Download Documents action
    1. Connect your Docusign account
    2. Select a Account
    3. Select a Envelope ID
    4. Select a Download Type
    5. Configure Filename
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Download Documents with Docusign API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Docusign
 
Try it
Download Documents with Docusign API on New Submission from Typeform API
Typeform + Docusign
 
Try it
Download Documents with Docusign API on New Submission (Instant) from Jotform API
Jotform + Docusign
 
Try it
Download Documents with Docusign API on New Scheduled Tasks from Pipedream API
Pipedream + Docusign
 
Try it
Download Documents with Docusign API on New Download Counts from npm API
npm + Docusign
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Download Documents on Docusign
Description:Download the documents of an envelope to the /tmp directory. [See the documentation here](https://developers.docusign.com/docs/esign-rest-api/how-to/download-envelope-documents/)
Version:0.0.1
Key:docusign-download-documents

Code

import docusign from "../../docusign.app.mjs";
import fs from "fs";

export default {
  key: "docusign-download-documents",
  name: "Download Documents",
  description: "Download the documents of an envelope to the /tmp directory. [See the documentation here](https://developers.docusign.com/docs/esign-rest-api/how-to/download-envelope-documents/)",
  version: "0.0.1",
  type: "action",
  props: {
    docusign,
    account: {
      propDefinition: [
        docusign,
        "account",
      ],
    },
    envelopeId: {
      type: "string",
      label: "Envelope ID",
      description: "Identifier of the envelope to download documents from",
      async options({ prevContext }) {
        const baseUri = await this.docusign.getBaseUri({
          accountId: this.account,
        });
        const { startPosition } = prevContext;
        const {
          envelopes = [], nextUri, endPosition,
        } = await this.docusign.listEnvelopes(baseUri, {
          start_position: startPosition,
          from_date: "2000-01-01",
        });
        return {
          options: envelopes.map(({
            envelopeId: value, emailSubject: label,
          }) => ({
            label,
            value,
          })),
          context: {
            startPosition: nextUri
              ? endPosition + 1
              : undefined,
          },
        };
      },
    },
    downloadType: {
      type: "string",
      label: "Download Type",
      description: "Download envelope documents to the `/tmp` directory",
      options: [
        {
          label: "All Documents (PDF)",
          value: "combined",
        },
        {
          label: "All Documents (Zip)",
          value: "archive",
        },
        {
          label: "Certificate (PDF)",
          value: "certificate",
        },
        {
          label: "Portfolio (PDF)",
          value: "portfolio",
        },
      ],
    },
    filename: {
      type: "string",
      label: "Filename",
      description: "The filename to save the file as in the `/tmp` directory including the file extension (.pdf or .zip)",
    },
  },
  methods: {
    getEnvelope($, baseUri, envelopeId) {
      return this.docusign._makeRequest({
        $,
        config: {
          url: `${baseUri}envelopes/${envelopeId}`,
        },
      });
    },
    async downloadToTmp($, baseUri, documentsUri, filePath) {
      const content = await this.docusign._makeRequest({
        $,
        config: {
          url: `${baseUri}${documentsUri.slice(1)}/${this.downloadType}`,
          responseType: "arraybuffer",
        },
      });
      const rawcontent = content.toString("base64");
      const buffer = Buffer.from(rawcontent, "base64");
      fs.writeFileSync(filePath, buffer);
    },
  },
  async run({ $ }) {
    const baseUri = await this.docusign.getBaseUri({
      accountId: this.account,
    });
    const envelope = await this.getEnvelope($, baseUri, this.envelopeId);
    const filePath = `/tmp/${this.filename}`;
    await this.downloadToTmp($, baseUri, envelope.documentsUri, filePath);

    $.export("$summary", `Successfully downloaded files to ${filePath}`);

    return filePath;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
DocusigndocusignappThis component uses the Docusign app.
AccountaccountstringSelect a value from the drop down menu.
Envelope IDenvelopeIdstringSelect a value from the drop down menu.
Download TypedownloadTypestringSelect a value from the drop down menu:{ "label": "All Documents (PDF)", "value": "combined" }{ "label": "All Documents (Zip)", "value": "archive" }{ "label": "Certificate (PDF)", "value": "certificate" }{ "label": "Portfolio (PDF)", "value": "portfolio" }
Filenamefilenamestring

The filename to save the file as in the /tmp directory including the file extension (.pdf or .zip)

Authentication

Docusign uses OAuth authentication. When you connect your Docusign account, Pipedream will open a popup window where you can sign into Docusign and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Docusign API.

Pipedream requests the following authorization scopes when you connect your account:

signatureextendedopenid

About Docusign

Electronic Signature and Agreement Cloud

More Ways to Use Docusign

Triggers

New Change in Envelope Status from the Docusign API

Emit new event when an envelope's status is updated

 
Try it
New Folder from the Docusign API

Emit new event when a new folder is created

 
Try it

Actions

Create Draft with the Docusign API

Create and send an envelope, or create a draft envelope. See the documentation here

 
Try it
Create Signature Request with the Docusign API

Creates a signature request from a template See the docs here

 
Try it

Explore Other Apps

1
-
24
of
2,400+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.