Connect BTCPay Server integrations

Verified

Self-hosted Bitcoin payments: invoices, payment requests, payouts, stores, webhooks and lightning, connected to WEXTL workflows and AI agents. Cut the manual copying out of BTCPay Server bookkeeping work. Start from Watch Events and send the data on through Get a File or Get a Lightning Address.

  • 3-day trial
  • Cancel anytime
  • Up to 10 minutes quick set up
  • GDPR
  • Data Encryption
  • 2FA
  • Local Data Region
  • BTCPay Server
  • WEXTL
  • Clientary
  • Korapay
  • Alpaca
  • Bling
  • YNAB
  • Billogram
  • Ordway
  • Veem
  • Hyfin
  • Credit Repair Cloud
  • Qvalia
  • Capium
  • HitPay
  • Xero
  • Payhip
  • Revolut Business
  • Priority
  • Sevdesk
  • Finale Inventory

Supported triggers and actions for BTCPay Server integration

Triggers can detect changes in BTCPay Server and run actions that can create, search or modify data inside BTCPay Server automatically[3], exactly how you set them.

  • Watch Events Fires instantly when BTCPay Server posts a webhook event. Each run has the Event Type and Delivery ID.
  • Get a File Reads an uploaded file with its Original Name and URL.
  • Get a Lightning Address Reads a Lightning address of a store by Username. You see its Min, Max and Invoice Metadata.
  • Get a Lightning Deposit Address Generates an on-chain Address that tops up a Lightning node.
  • Get a Lightning Invoice Reads an invoice from a Lightning node by Lightning Invoice ID, including its BOLT11 string and a Status that tells whether it was paid.
  • Get a Lightning Node Balance Reads how much funds a Lightning node holds, split into two parts by Onchain and Offchain.
  • Get a Lightning Node Info Reads a Lightning node and its Alias, Version, Block Height and Peers Count.
  • Get a Lightning Payment Fetches one payment of a Lightning node by Payment Hash. It shows the Status and Preimage.
  • Get a Notification Opens one notification from your inbox with its Type, Body and Link.
  • Get a Payment Request Retrieves a payment request with its Title, Amount and Expiry Date.
  • Get a Payout Checks a payout and shows its Destination, Revision and Original Currency.
  • Get a Pull Payment Loads a pull payment with its Amount, Currency and BOLT11 Expiration.
  • Get a Pull Payment LNURL Gives the LNURL for a pull payment in two forms, LNURL Bech32 and LNURL URI.
  • Get a Pull Payment Payout Reads a single payout that was claimed against a pull payment, with its Destination and Date.
  • Get a Rate Configuration Shows how a store converts rates, with the Spread, the Preferred Source and the Effective Script.
  • Get a Store Reads a store with its Name, Website and Logo URL.
  • Get a Store Payment Method Reads one payment method on a store and whether it is Enabled. Turn on Include Config to add its configuration.
  • Get a Subscriber Finds a subscriber of an offering and shows the Plan, Period End and Trial End.
  • Get a Subscriber Credit Reads the credit balance that a subscriber holds in one Currency.
  • Get a User Gets a user by id or email, along with the Email Confirmed state.

How to integrate BTCPay Server in automation workflow?

BTCPay Server in three steps: start with "Watch Events", connect one credential, then add your next step.

How BTCPay Server connects and integrates with WEXTL

Save and approve your credentials once. WEXTL® stores authorization information encrypted and reuses the authentication whenever BTCPay Server app is called in workflows. That allows your finance automations to run without your attention, per defined schedule[7]. See the integration guide[6] for a detailed list of fields that BTCPay Server supports.

Full BTCPay Server API documentation

The following table illustrates what fields BTCPay Server integration require during authorization flow inside our workflow builder[4].

Connect BTCPay Server

  • Server URL*Text

    ••••••••

  • API Key*Text

    ••••••••

Demonstration of BTCPay Server connection step inside WEXTL Workflow Builder[4].
FieldTypeHelp
Server URLRequired
text

The address you open BTCPay Server at, for example https://btcpay.example.com (no path after it unless your server runs under one). It must start with https:// and be reachable from the internet on the standard HTTPS port or a common alternative. Servers on a LAN address, localhost or .onion cannot be reached.

API KeyRequired
password

In BTCPay Server open Account, Manage Account, API Keys and create a key. Tick only the permissions your workflows need. Unrestricted access works for testing.

Connect BTCPay Server to popular apps on WEXTL

Enter a name of the other app you want to sync with BTCPay Server below. Click on selected app to explore integration options with BTCPay Server. If the app you search for is not available in WEXTL yet, you can use HTTP node[10] instead to integrate it directly.

Example automation with BTCPay Server integration

Select Watch Events trigger from BTCPay Server - this will be a starting point in your automation. Whenever event happens in BTCPay Server, workflow will start[7] from Watch Events node.

Search for Add a Store User, connect it as the next step of integration sequence. You can use filters between Watch Events and Add a Store User, so only important data pass from Watch Events to the next step. WEXTL gives you full control over the process of BTCPay Server automation. All parts of workflow are visible on the canvas[4].

BTCPay Server on WEXTL has 150 modules for building finance automations. Explore BTCPay Server documentation for more.

  • BTCPay ServerWatch Events
  • ClientaryPerforms action

OR

  • ClientaryTriggers
  • BTCPay ServerAdd a Store User
Demonstration of how visual BTCPay Server automation[6] looks in WEXTL.

Frequently asked questions

Common questions about automating BTCPay Server in your workflows.

What triggers does BTCPay Server support?

BTCPay Server has 1 trigger, including "Watch Events". Triggers are start points of the workflow, and automations may start from them.

What actions can I run in BTCPay Server?

Integration has 149 actions, including "Get a File", "Get a Lightning Address", and "Get a Lightning Deposit Address", and more. Refer to our BTCPay Server Documentation for detailed inputs and outputs.

Do I need to write code to build automations?

No. The 149 BTCPay Server modules, like "Get a File", are forms on the canvas: pick a field, map data from an earlier step. Code is optional[4].

Is the integration secure?

Yes. You fill in the BTCPay Server credential once. WEXTL encrypts it at rest, and only your team can use it.

How does WEXTL integrate with BTCPay Server?

Through the official BTCPay Server API: 149 modules, plus "Make an API Call" for any endpoint they don't cover[3].

Can I use webhooks with BTCPay Server?

Yes. "Watch Events" is instant: BTCPay Server pushes each event, so there is no polling delay.

Why use WEXTL platform for BTCPay Server automation?

WEXTL is an AI-first visual canvas: describe the BTCPay Server flow in plain words and AI wires the nodes[4].

Automate BTCPay Server on WEXTL®

Claim your 3-day trial to build BTCPay Server integrations and access every WEXTL® feature.

Cancel anytime.

References

List of sources used to gather information about the BTCPay Server integration.

  1. BTCPay Server integration source code, module specs and credentials implementation.
  2. Internal BTCPay Server integration documentation, structured input and output parameters, scopes, and authentication methods.
  3. Official BTCPay Server vendor API documentation, used to verify field meanings, authentication flows, and anything our own specs don't fully capture.
  4. WEXTL® Visual Workflow Builder, anonymized data from our technical support team.
  5. WEXTL® Apps Library
  6. WEXTL® BTCPay Server App Documentation
  7. WEXTL® Workflow Scheduler
  8. WEXTL® HTTP node documentation

How we write and maintain BTCPay Server app documentation

Explore how WEXTL® crafted BTCPay Server integration page documentation. Used sources, the role of AI, and how the team validates the result.