Create Document with Formstack Documents API on New Branch Created from GitHub API

Pipedream makes it easy to connect APIs for Formstack Documents, GitHub and 2,900+ other apps remarkably fast.

Trigger workflow on

New Branch Created from the GitHub API

Next, do this

Create Document with the Formstack Documents 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 GitHub trigger and Formstack Documents action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Branch Created trigger
1. Connect your GitHub account
2. Select a Repository
Configure the Create Document action
1. Connect your Formstack Documents account
2. Configure Name
3. Select a Type
4. Select a Output
5. Optional- Configure Folder
6. Optional- 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 Branch Created on GitHub

Description:Emit new event when a branch is created.

Version:1.0.11

Key:github-new-branch

View on GitHub

GitHub Overview#

The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.

Trigger Code#

import common from "../common/common-flex.mjs";
import {
  getSampleTimerEvent, getSampleWebhookEvent,
} from "./common-sample-events.mjs";

export default {
  ...common,
  key: "github-new-branch",
  name: "New Branch Created",
  description: "Emit new event when a branch is created.",
  version: "1.0.11",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getSampleTimerEvent,
    getSampleWebhookEvent,
    getWebhookEvents() {
      return [
        "create",
      ];
    },
    shouldEmitWebhookEvent(body) {
      return body?.ref_type === "branch";
    },
    getId(item) {
      return item.ref ?? item.name;
    },
    getSummary(item) {
      return `New branch: ${this.getId(item)}`;
    },
    getPollingData(args) {
      return this.github.getBranches(args);
    },
    getHttpDocsLink() {
      return "https://docs.github.com/en/webhooks/webhook-events-and-payloads#create";
    },
    getTimerDocsLink() {
      return "https://docs.github.com/en/rest/branches/branches?apiVersion=2022-11-28#list-branches";
    },
  },
};

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
GitHub	`github`	`app`	This component uses the GitHub app.
Repository	`repoFullname`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

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

reporead:orgadmin:org_hookgistprojectnotificationsread:userwrite:discussionadmin:repo_hook

About GitHub#

Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.

Action#

Create Document on Formstack Documents

Description:Create a new document. [See documentation](https://www.webmerge.me/developers?page=documents)

Version:1.0.2

Key:formstack_documents-create-document

View on GitHub

Formstack Documents Overview#

The Formstack Documents API gives you the power to automate document creation and delivery, making it simple to generate custom PDFs, Word documents, PowerPoint presentations, and more, from your data. By leveraging the API within Pipedream, you can integrate dynamic document generation into your workflows. You might merge data from various sources, populate templates with real-time data, and send documents directly to customers or team members.

Action Code#

import formstackDocuments from "../../formstack_documents.app.mjs";
import {
  ConfigurationError, getFileStream,
} from "@pipedream/platform";

export default {
  key: "formstack_documents-create-document",
  name: "Create Document",
  description: "Create a new document. [See documentation](https://www.webmerge.me/developers?page=documents)",
  version: "1.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    formstackDocuments,
    name: {
      type: "string",
      label: "Name",
      description: "The document name",
    },
    type: {
      propDefinition: [
        formstackDocuments,
        "documentType",
      ],
      reloadProps: true,
    },
    output: {
      propDefinition: [
        formstackDocuments,
        "documentOutput",
      ],
    },
    folder: {
      type: "string",
      label: "Folder",
      description: "The name of the folder to save the document in. If folder doesn't exist, one will be created.",
      optional: true,
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.type === "html") {
      props.html = {
        type: "string",
        label: "HTML",
        description: "The HTML of the document",
      };
      props.width = {
        type: "string",
        label: "Width",
        description: "The width of the document (inches)",
        optional: true,
      };
      props.height = {
        type: "string",
        label: "Height",
        description: "The height of the document (inches)",
        optional: true,
      };
    } else {
      props.file = {
        type: "string",
        label: "File Path or URL",
        description: "Provide a file URL or a path to a file in the `/tmp` directory.",
      };
    }
    return props;
  },
  methods: {
    streamToBase64(stream) {
      return new Promise((resolve, reject) => {
        const chunks = [];
        stream.on("data", (chunk) => chunks.push(chunk));
        stream.on("end", () => {
          const buffer = Buffer.concat(chunks);
          resolve(buffer.toString("base64"));
        });
        stream.on("error", reject);
      });
    },
  },
  async run({ $ }) {
    if (this.type !== "html" && !this.file) {
      throw new ConfigurationError("The File field is required for the selected document type.");
    }

    const data = {
      name: this.name,
      type: this.type,
      output: this.output,
      folder: this.folder,
    };

    if (this.type === "html") {
      data.html = this.html;
      data.size_width = this.width;
      data.size_height = this.height;
    }

    if (this.file) {
      const stream = await getFileStream(this.file);
      data.file_contents = await this.streamToBase64(stream);
    }

    const response = await this.formstackDocuments.createDocument({
      data,
      $,
    });

    if (response) {
      $.export("$summary", `Successfully created document with ID ${response.id}.`);
    }

    return response;
  },
};

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
Formstack Documents	`formstackDocuments`	`app`	This component uses the Formstack Documents app.
Name	`name`	`string`	The document name
Type	`type`	`string`	Select a value from the drop down menu:`htmlpdfdocxxlsxpptx`
Output	`output`	`string`	Select a value from the drop down menu:`pdfdocxxlsxpptxemail`
Folder	`folder`	`string`	The name of the folder to save the document in. If folder doesn't exist, one will be created.
syncDir	`syncDir`	`dir`

Action Authentication#

Formstack Documents uses API keys for authentication. When you connect your Formstack Documents account, Pipedream securely stores the keys so you can easily authenticate to Formstack Documents APIs in both code and no-code steps.

To retrieve your API keys,