Trigger a Pipeline with CircleCI API on Recipient Completed (Instant) from PandaDoc API

Pipedream makes it easy to connect APIs for CircleCI, PandaDoc and 2,700+ other apps remarkably fast.

Trigger workflow on

Recipient Completed (Instant) from the PandaDoc API

Next, do this

Trigger a Pipeline with the CircleCI 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 PandaDoc trigger and CircleCI action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Recipient Completed (Instant) trigger
1. Connect your PandaDoc account
Configure the Trigger a Pipeline action
1. Connect your CircleCI account
2. Configure alert
3. Configure Project Slug
4. Configure Definition ID
5. Optional- Configure Config Branch
6. Optional- Configure Config Tag
7. Optional- Configure Checkout Branch
8. Optional- Configure Checkout Tag
9. Optional- Configure Parameters
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#

Recipient Completed (Instant) on PandaDoc

Description:Emit new event when a recipient completes a document. [See the documentation here](https://developers.pandadoc.com/reference/create-webhooks-subscription)

Version:0.0.5

Key:pandadoc-recipient-completed

View on GitHub

PandaDoc Overview#

The PandaDoc API opens up a realm of possibilities for automating document workflows, creating a seamless bridge between document management and various business processes. With it, you can programmatically create, send, and track documents, streamline electronic signatures, and manage templates, among others. Integrations through Pipedream can harness these capabilities, enabling you to trigger actions in PandaDoc based on events from other apps, or vice versa.

Trigger Code#

import common from "../common.mjs";

const DOCS_LINK = "https://developers.pandadoc.com/reference/create-webhooks-subscription";

export default {
  ...common,
  name: "Recipient Completed (Instant)",
  description:
    `Emit new event when a recipient completes a document. [See the documentation here](${DOCS_LINK})`,
  key: "pandadoc-recipient-completed",
  version: "0.0.5",
  type: "source",
  methods: {
    ...common.methods,
    getHookName() {
      return "Recipient Completed";
    },
    getHookTypes() {
      return [
        "recipient_completed",
      ];
    },
  },
};

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
PandaDoc	`app`	`app`	This component uses the PandaDoc app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.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.

Trigger Authentication#

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

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

read+write

About PandaDoc#

Create, Approve, Track & eSign Docs 40% Faster

Action#

Trigger a Pipeline on CircleCI

Description:Trigger a pipeline given a pipeline definition ID. Supports all integrations except GitLab. [See the documentation](https://circleci.com/docs/api/v2/index.html#tag/Pipeline/operation/triggerPipelineRun)

Version:0.0.1

Key:circleci-trigger-pipeline

View on GitHub

CircleCI Overview#

The CircleCI API allows for seamless integration and automation of your CI/CD pipeline. By leveraging the API through Pipedream, you can trigger builds, monitor the status of pipelines, fetch build artifacts, and interact with various aspects of your CircleCI projects. This facilitates the creation of dynamic workflows that can streamline development practices, enhance deployment strategies, and ensure continuous integration processes are more efficient and less error-prone.

Action Code#

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

export default {
  key: "circleci-trigger-pipeline",
  name: "Trigger a Pipeline",
  description: "Trigger a pipeline given a pipeline definition ID. Supports all integrations except GitLab. [See the documentation](https://circleci.com/docs/api/v2/index.html#tag/Pipeline/operation/triggerPipelineRun)",
  version: "0.0.1",
  type: "action",
  props: {
    circleci,
    alert: {
      type: "alert",
      alertType: "info",
      content: "Supports all integrations except GitLab.",
    },
    projectSlug: {
      propDefinition: [
        circleci,
        "projectSlug",
      ],
    },
    definitionId: {
      type: "string",
      label: "Definition ID",
      description: "The unique ID for the pipeline definition. This can be found in the page Project Settings > Pipelines.",
    },
    configBranch: {
      type: "string",
      label: "Config Branch",
      description: "The branch that should be used to fetch the config file. Note that branch and tag are mutually exclusive. To trigger a pipeline for a PR by number use pull//head for the PR ref or pull//merge for the merge ref (GitHub only)",
      optional: true,
    },
    configTag: {
      type: "string",
      label: "Config Tag",
      description: "The tag that should be used to fetch the config file. The commit that this tag points to is used for the pipeline. Note that branch and tag are mutually exclusive.",
      optional: true,
    },
    checkoutBranch: {
      type: "string",
      label: "Checkout Branch",
      description: "The branch that should be used to check out code on a checkout step. Note that branch and tag are mutually exclusive. To trigger a pipeline for a PR by number use pull//head for the PR ref or pull//merge for the merge ref (GitHub only)",
      optional: true,
    },
    checkoutTag: {
      type: "string",
      label: "Checkout Tag",
      description: "The tag that should be used to check out code on a checkout step. The commit that this tag points to is used for the pipeline. Note that branch and tag are mutually exclusive.",
      optional: true,
    },
    parameters: {
      type: "object",
      label: "Parameters",
      description: "An object containing pipeline parameters and their values. Pipeline parameters have the following size limits: 100 max entries, 128 maximum key length, 512 maximum value length.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.circleci.triggerPipeline({
      $,
      projectSlug: this.projectSlug,
      data: {
        definition_id: this.definitionId,
        config: this.configBranch || this.configTag
          ? {
            branch: this.configBranch,
            tag: this.configTag,
          }
          : undefined,
        checkout: this.checkoutBranch || this.checkoutTag
          ? {
            branch: this.checkoutBranch,
            tag: this.checkoutTag,
          }
          : undefined,
        parameters: typeof this.parameters === "string"
          ? JSON.parse(this.parameters)
          : this.parameters,
      },
    });

    if (response?.id) {
      $.export("$summary", `Successfully triggered pipeline 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
CircleCI	`circleci`	`app`	This component uses the CircleCI app.
Project Slug	`projectSlug`	`string`	Project slug in the form `vcs-slug/org-name/repo-name` (found in Project Settings)
Definition ID	`definitionId`	`string`	The unique ID for the pipeline definition. This can be found in the page Project Settings > Pipelines.
Config Branch	`configBranch`	`string`	The branch that should be used to fetch the config file. Note that branch and tag are mutually exclusive. To trigger a pipeline for a PR by number use pull//head for the PR ref or pull//merge for the merge ref (GitHub only)
Config Tag	`configTag`	`string`	The tag that should be used to fetch the config file. The commit that this tag points to is used for the pipeline. Note that branch and tag are mutually exclusive.
Checkout Branch	`checkoutBranch`	`string`	The branch that should be used to check out code on a checkout step. Note that branch and tag are mutually exclusive. To trigger a pipeline for a PR by number use pull//head for the PR ref or pull//merge for the merge ref (GitHub only)
Checkout Tag	`checkoutTag`	`string`	The tag that should be used to check out code on a checkout step. The commit that this tag points to is used for the pipeline. Note that branch and tag are mutually exclusive.
Parameters	`parameters`	`object`	An object containing pipeline parameters and their values. Pipeline parameters have the following size limits: 100 max entries, 128 maximum key length, 512 maximum value length.

Trigger a Pipeline with CircleCI API on Recipient Completed (Instant) from PandaDoc API

Pipedream makes it easy to connect APIs for CircleCI, PandaDoc and 2,700+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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