Download Documents with Docusign API on New Requests from HTTP / Webhook API

Pipedream makes it easy to connect APIs for Docusign, HTTP / Webhook and 2,900+ other apps remarkably fast.

Trigger workflow on

New Requests from the HTTP / Webhook API

Next, do this

Download Documents with the Docusign API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a HTTP / Webhook trigger and Docusign action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Requests trigger
1. Optional- Configure Body Only
2. Optional- Configure Response Status Code
3. Optional- Configure Response Content-Type
4. Optional- Configure Response Body
5. Connect your HTTP / Webhook account
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
6. Configure syncDir
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Requests on HTTP / Webhook

Description:Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.

Version:0.1.1

Key:http-new-requests

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Trigger Code#

import http from "../../http.app.mjs";

// Core HTTP component
export default {
  key: "http-new-requests",
  name: "New Requests",
  description: "Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.",
  version: "0.1.1",
  type: "source",
  props: {
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    emitBodyOnly: {
      type: "boolean",
      label: "Body Only",
      description: "This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.",
      optional: true,
      default: false,
    },
    resStatusCode: {
      type: "string",
      label: "Response Status Code",
      description: "The status code to return in the HTTP response",
      optional: true,
      default: "200",
    },
    resContentType: {
      type: "string",
      label: "Response Content-Type",
      description: "The `Content-Type` of the body returned in the HTTP response",
      optional: true,
      default: "application/json",
    },
    resBody: {
      type: "string",
      label: "Response Body",
      description: "The body to return in the HTTP response",
      optional: true,
      default: "{ \"success\": true }",
    },
    http,
  },
  async run(event) {
    const summary = `${event.method} ${event.path}`;

    this.httpInterface.respond({
      status: this.resStatusCode,
      body: this.resBody,
      headers: {
        "content-type": this.resContentType,
      },
    });

    if (this.emitBodyOnly) {
      this.$emit(event.body, {
        summary,
      });
    } else {
      this.$emit(event, {
        summary,
      });
    }
  },
};

Trigger 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.

Label	Prop	Type	Description
N/A	`httpInterface`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Body Only	`emitBodyOnly`	`boolean`	This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.
Response Status Code	`resStatusCode`	`string`	The status code to return in the HTTP response
Response Content-Type	`resContentType`	`string`	The `Content-Type` of the body returned in the HTTP response
Response Body	`resBody`	`string`	The body to return in the HTTP response
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

Action#

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.3

Key:docusign-download-documents

View on GitHub

Docusign Overview#

The DocuSign API enables you to integrate electronic signature workflows into your applications, automate the process of sending and receiving documents for signatures, and securely manage related data. Leveraging Pipedream's platform, you can build powerful automations that streamline how contracts and agreements are handled, enhance compliance, and improve overall efficiency.

Action 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.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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)",
    },
    syncDir: {
      type: "dir",
      accessMode: "write",
      sync: true,
    },
  },
  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;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Docusign	`docusign`	`app`	This component uses the Docusign app.
Account	`account`	`string`	Select a value from the drop down menu.
Envelope ID	`envelopeId`	`string`	Select a value from the drop down menu.
Download Type	`downloadType`	`string`	Select 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" }`
Filename	`filename`	`string`	The filename to save the file as in the `/tmp` directory including the file extension (.pdf or .zip)
syncDir	`syncDir`	`dir`

Action 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 Connect Docusign + HTTP / Webhook#

Other Popular Integrations#

Custom Request with HTTP / Webhook API on Envelope Sent or Complete from Docusign API

Docusign + HTTP / Webhook