Trigger a Pipeline with CircleCI API on New Custom Webhook Events from Stripe API

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

Trigger workflow on

New Custom Webhook Events from the Stripe 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 Stripe 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 New Custom Webhook Events trigger
1. Connect your Stripe account
2. Select one or more Events
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#

New Custom Webhook Events on Stripe

Description:Emit new event on each webhook event

Version:0.1.1

Key:stripe-custom-webhook-events

View on GitHub

Stripe Overview#

The Stripe API is a powerful tool for managing online payments, subscriptions, and invoices. With Pipedream, you can leverage this API to automate payment processing, monitor transactions, and sync billing data with other services. Pipedream's no-code platform allows for quick integration and creation of serverless workflows that react to Stripe events in real-time. For instance, you might automatically update customer records, send personalized emails after successful payments, or escalate failed transactions to your support team.

Trigger Code#

import constants from "../common/constants.mjs";
import sampleEmit from "./test-event.mjs";
import common from "../common/webhook-base.mjs";

export default {
  ...common,
  key: "stripe-custom-webhook-events",
  name: "New Custom Webhook Events",
  type: "source",
  version: "0.1.1",
  description: "Emit new event on each webhook event",
  props: {
    ...common.props,
    enabledEvents: {
      type: "string[]",
      label: "Events",
      description: "Events to listen for. Select `*` for all events",
      options: constants.WEBHOOK_EVENTS,
      default: [
        "*",
      ],
    },
  },
  methods: {
    ...common.methods,
    getEvents() {
      return this.enabledEvents;
    },
  },
  sampleEmit,
};

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
Stripe	`stripe`	`app`	This component uses the Stripe app.
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Events	`enabledEvents`	`string[]`	Select a value from the drop down menu:`*account.application.authorizedaccount.application.deauthorizedaccount.external_account.createdaccount.external_account.deletedaccount.external_account.updatedaccount.updatedapplication_fee.createdapplication_fee.refund.updatedapplication_fee.refundedbalance.availablecapability.updatedcharge.capturedcharge.dispute.closedcharge.dispute.createdcharge.dispute.funds_reinstatedcharge.dispute.funds_withdrawncharge.dispute.updatedcharge.expiredcharge.failedcharge.pendingcharge.refund.updatedcharge.refundedcharge.succeededcharge.updatedcheckout.session.async_payment_failedcheckout.session.async_payment_succeededcheckout.session.completedcoupon.createdcoupon.deletedcoupon.updatedcredit_note.createdcredit_note.updatedcredit_note.voidedcustomer.createdcustomer.deletedcustomer.discount.createdcustomer.discount.deletedcustomer.discount.updatedcustomer.source.createdcustomer.source.deletedcustomer.source.expiringcustomer.source.updatedcustomer.subscription.createdcustomer.subscription.deletedcustomer.subscription.pending_update_appliedcustomer.subscription.pending_update_expiredcustomer.subscription.trial_will_endcustomer.subscription.updatedcustomer.tax_id.createdcustomer.tax_id.deletedcustomer.tax_id.updatedcustomer.updatedfile.createdinvoice.createdinvoice.deletedinvoice.finalizedinvoice.marked_uncollectibleinvoice.paidinvoice.payment_action_requiredinvoice.payment_failedinvoice.payment_succeededinvoice.sentinvoice.upcominginvoice.updatedinvoice.voidedinvoiceitem.createdinvoiceitem.deletedinvoiceitem.updatedissuing_authorization.createdissuing_authorization.requestissuing_authorization.updatedissuing_card.createdissuing_card.updatedissuing_cardholder.createdissuing_cardholder.updatedissuing_dispute.createdissuing_dispute.funds_reinstatedissuing_dispute.updatedissuing_transaction.createdissuing_transaction.updatedmandate.updatedorder.createdorder.payment_failedorder.payment_succeededorder.updatedorder_return.createdpayment_intent.amount_capturable_updatedpayment_intent.canceledpayment_intent.createdpayment_intent.payment_failedpayment_intent.processingpayment_intent.succeededpayment_method.attachedpayment_method.card_automatically_updatedpayment_method.detachedpayment_method.updatedpayout.canceledpayout.createdpayout.failedpayout.paidpayout.updatedperson.createdperson.deletedperson.updatedplan.createdplan.deletedplan.updatedprice.createdprice.deletedprice.updatedproduct.createdproduct.deletedproduct.updatedradar.early_fraud_warning.createdradar.early_fraud_warning.updatedrecipient.createdrecipient.deletedrecipient.updatedreporting.report_run.failedreporting.report_run.succeededreporting.report_type.updatedreview.closedreview.openedsetup_intent.canceledsetup_intent.createdsetup_intent.setup_failedsetup_intent.succeededsigma.scheduled_query_run.createdsku.createdsku.deletedsku.updatedsource.canceledsource.chargeablesource.failedsource.mandate_notificationsource.refund_attributes_requiredsource.transaction.createdsource.transaction.updatedsubscription_schedule.abortedsubscription_schedule.canceledsubscription_schedule.completedsubscription_schedule.createdsubscription_schedule.expiringsubscription_schedule.releasedsubscription_schedule.updatedtax_rate.createdtax_rate.updatedtopup.canceledtopup.createdtopup.failedtopup.reversedtopup.succeededtransfer.createdtransfer.failedtransfer.paidtransfer.reversedtransfer.updated`

Trigger Authentication#

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

Stripe uses API keys to authenticate requests (more info in their docs here).

To connect Pipedream to your Stripe account,

Create a Stripe API key
Click "Create Restricted Key"
Enter the Restricted API key below.

To help ensure proper security, we recommend you create a Restricted key with scopes relevant to the specific operations you will use in Pipedream.

About Stripe#

Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.

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.

Action Authentication#

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

An API token can be created using the account dashboard. More info via API Overview.

About CircleCI#

Continuous integration and delivery platform

More Ways to Connect CircleCI + Stripe#

Other Popular Integrations#

Rerun Workflow with CircleCI API on New Abandoned Cart from Stripe API

Stripe + CircleCI

Trigger a Pipeline with CircleCI API on New Custom Webhook Events from Stripe API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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