Create Payment Request with BTCPay Server API on New Click (Instant) from Mailgun API

Pipedream makes it easy to connect APIs for BTCPay Server, Mailgun and 2,800+ other apps remarkably fast.

Trigger workflow on

New Click (Instant) from the Mailgun API

Next, do this

Create Payment Request with the BTCPay Server 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 Mailgun trigger and BTCPay Server action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Click (Instant) trigger
1. Connect your Mailgun account
2. Select a Domain Name
3. Configure Mailgun webhook signing key
Configure the Create Payment Request action
1. Connect your BTCPay Server account
2. Select a Store ID
3. Configure Amount
4. Configure Title
5. Optional- Configure Currency
6. Optional- Configure Description
7. Optional- Configure Email
8. Optional- Configure Expiry Date
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 Click (Instant) on Mailgun

Description:Emit new event when the email recipient clicked on a link in the email. Open tracking must be enabled in the Mailgun control panel, and the CNAME record must be pointing to mailgun.org. See more at the Mailgun User's Manual [Tracking Messages](https://documentation.mailgun.com/en/latest/user_manual.html#tracking-messages) section

Version:0.0.3

Key:mailgun-new-click

View on GitHub

Mailgun Overview#

The Mailgun API on Pipedream is a potent tool for automating email operations without the overhead of managing a full-fledged email server. It offers capabilities to send, receive, track, and store emails with ease. With Pipedream's serverless platform, you can trigger workflows using Mailgun events, such as inbound emails or delivery status changes, and connect them to hundreds of other services to streamline communication, marketing, and notification systems within your ecosystem.

Trigger Code#

import common from "../common/http-based.mjs";

export default {
  ...common,
  key: "mailgun-new-click",
  name: "New Click (Instant)",
  description: "Emit new event when the email recipient clicked on a link in the email. " +
    "Open tracking must be enabled in the Mailgun control panel, and the CNAME record " +
    "must be pointing to mailgun.org. See more at the Mailgun User's Manual [Tracking Messages]" +
    "(https://documentation.mailgun.com/en/latest/user_manual.html#tracking-messages) " +
    "section",
  version: "0.0.3",
  dedupe: "unique",
  type: "source",
  methods: {
    ...common.methods,
    getEventName() {
      return [
        "clicked",
      ];
    },
    getEventType() {
      return [
        "CLICKED",
        "clicked",
      ];
    },
  },
};

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
Mailgun	`mailgun`	`app`	This component uses the Mailgun app.
Domain Name	`domain`	`string`	Select a value from the drop down menu.
Mailgun webhook signing key	`webhookSigningKey`	`string`	Your Mailgun webhook signing key, found in your Mailgun dashboard, located under Settings on the left-hand nav and then in API Keys look for webhook signing key. Required to compute the authentication signature of events.
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#

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

About Mailgun#

Mailgun is an email automation service built for developers. Powerful transactional email APIs enable you to send, receive, and track emails.

Action#

Create Payment Request on BTCPay Server

Description:Generates a new payment request for a user. [See the documentation](https://docs.btcpayserver.org/API/Greenfield/v1/#operation/PaymentRequests_CreatePaymentRequest)

Version:0.0.2

Key:btcpay_server-create-payment-request

View on GitHub

BTCPay Server Overview#

The BTCPay Server API provides a robust interface for automating payment processing, managing invoices, and overseeing stores within a BTCPay Server instance. Leveraging Pipedream, you can build powerful serverless workflows that react to events in BTCPay Server, such as new payments or invoice statuses, and integrate with countless other services through Pipedream's platform.

Action Code#

import btcPayServer from "../../btcpay_server.app.mjs";

export default {
  key: "btcpay_server-create-payment-request",
  name: "Create Payment Request",
  description: "Generates a new payment request for a user. [See the documentation](https://docs.btcpayserver.org/API/Greenfield/v1/#operation/PaymentRequests_CreatePaymentRequest)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    btcPayServer,
    storeId: {
      propDefinition: [
        btcPayServer,
        "storeId",
      ],
    },
    amount: {
      type: "string",
      label: "Amount",
      description: "The amount of the payment request",
    },
    title: {
      type: "string",
      label: "Title",
      description: "The title of the payment request",
    },
    currency: {
      type: "string",
      label: "Currency",
      description: "The currency of the payment request. If empty, the store's default currency code will be used.",
      optional: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "The description of the payment request",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "The email used in invoices generated by the payment request",
      optional: true,
    },
    expiryDate: {
      type: "string",
      label: "Expiry Date",
      description: "The expiry date of the payment request in ISO 8601 format.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.btcPayServer.createPaymentRequest({
      $,
      storeId: this.storeId,
      data: {
        amount: this.amount,
        currency: this.currency,
        title: this.title,
        description: this.description,
        email: this.email,
        expiryDate: this.expiryDate && (Date.parse(this.expiryDate)) / 1000,
      },
    });
    $.export("$summary", `Successfully created payment request 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
BTCPay Server	`btcPayServer`	`app`	This component uses the BTCPay Server app.
Store ID	`storeId`	`string`	Select a value from the drop down menu.
Amount	`amount`	`string`	The amount of the payment request
Title	`title`	`string`	The title of the payment request
Currency	`currency`	`string`	The currency of the payment request. If empty, the store's default currency code will be used.
Description	`description`	`string`	The description of the payment request
Email	`email`	`string`	The email used in invoices generated by the payment request
Expiry Date	`expiryDate`	`string`	The expiry date of the payment request in ISO 8601 format.

Action Authentication#

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

About BTCPay Server#

Best way to accept Bitcoin. No fees, no intermediary. Free, open source & self-hosted Bitcoin payment processor for self-sovereign individuals and businesses.

More Ways to Connect BTCPay Server + Mailgun#

Other Popular Integrations#

Create Payment Request with BTCPay Server API on New Bounce (Instant) from Mailgun API

Mailgun + BTCPay Server

Create Payment Request with BTCPay Server API on New Click (Instant) from Mailgun API

Pipedream makes it easy to connect APIs for BTCPay Server, Mailgun and 2,800+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,800+apps by most popular

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