Connect BTCPay Server integrations
VerifiedSelf-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
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.
- Get a Wallet Fee Rate Estimates the Fee Rate for an on-chain payment method. Use Block Target to say how fast you want confirmation.
- Get a Wallet Overview Shows a store wallet with its Confirmed Balance and Unconfirmed Balance.
- Get a Wallet Receive Address Provides an on-chain Address with its Key Path and Payment Link. Turn on Force New Address to skip a reused one.
- Get a Wallet Transaction Reads one on-chain transaction from a wallet by Transaction ID. Shows its Confirmations and Block Height.
- Get a Webhook Reads a store webhook with its URL, Authorized Events and Automatic Redelivery setting.
- Get a Webhook Delivery Checks how one delivery went, through Http Code, Error Message and Status.
- Get a Webhook Delivery Request Returns the Request that BTCPay Server sent to your endpoint during one webhook delivery.
- Get an App Reads an app with its App Name, App Type and whether it is Archived.
- Get an Invoice Reads an invoice with its Amount, Metadata and Checkout settings. Turn on Include Payment Methods to add its payment methods.
- Get an Offering Pulls a subscription offering with its Features and Success Redirect URL.
- Get an Offering Plan Looks up one plan of an offering and shows its Price, Currency and Recurring Type.
- Get App Details Reads the type-specific details of an app, which depend on its App Type.
- Get App Sales Reads the sales of an app as a Sales Count and a Series. Use Number of Days to choose how far back to look.
- Get App Top Items Lists the best selling items of an app with their Sales Count and Total. Use Count and Offset to page through them.
- Get Invoice Refund Details Shows what a refund of an invoice would pay, comparing the Payment Amount Then and the Payment Amount Now.
- Get Lightning Balance History Reads how a Lightning node balance moved over time, as a Series with Labels.
- Get Notification Settings Returns the alert types you can receive through Notifications, each with its on or off state.
- Get Store Email Settings Reads the SMTP setup used for store emails, showing Server, Port and Login. It also shows whether a password is stored.
- Get Store Rates Fetches current exchange rates for a store. Use Currency Pairs such as BTC_USD to ask for specific ones.
- Get the Current API Key Reads the API key used for this call, with its Label and Permissions.
- Get the Current User Reads the user that owns the credential, with its Email and Name.
- Get the Server Health Checks whether BTCPay Server has finished catching up with the blockchain, as the Synchronized flag.
- Get the Server Info Describes the server through its Version, Supported Payment Methods and Sync Status.
- Get Wallet History Reads the on-chain balance history of a store wallet as a Series with Labels.
- List Apps Browses the apps on the server. Use Store to narrow the list down to one store.
- List Files Gathers the files uploaded to BTCPay Server, each with its Original Name and URL.
- List Invoice Payment Methods Lists payment options an invoice offers, each with its Destination and Rate.
- List Invoices Searches a store for invoices. Filter by Status, Order IDs or a Start Date and End Date, and use Limit to read fewer.
- List Lightning Addresses Returns every Lightning address set up in a store, with its Username, Min and Max.
- List Lightning Channels Shows the channels a Lightning node has open, with Capacity, Local Balance and whether each one Is Active.
- List Lightning Invoices Collects invoices from a Lightning node. Use Pending Only to skip paid ones and Offset Index to continue from a position.
- List Lightning Payments Pulls payments made from a Lightning node. Turn on Include Pending to add unfinished ones and use Offset Index to continue.
- List Notifications Reads your inbox notifications. Use Seen to keep only seen or unseen ones, Store IDs to focus on some stores, and Limit to read fewer.
- List Offerings Finds subscription offerings in a store, including Features and Success Redirect URL.
- List Payment Requests Fetches payment requests from a store, including Title, Amount and Expiry Date.
- List Payout Processors Shows which payout processors the server offers, by Friendly Name and Payout Methods.
- List Pull Payment Payouts Lists the payouts claimed on a pull payment. Turn on Include Cancelled to see the cancelled ones too.
- List Pull Payments Gives pull payments from a store with their Amount and Currency. Turn on Include Archived to add archived ones.
- List Rate Sources Lists exchanges that BTCPay Server can pull rates from, by ID and Name.
- List Reports Gathers the names of reports that a store can run, which feed Run a Report.
- List Roles Shows roles with their Permissions. Pick a Scope to read store roles or server roles.
- List Store Invitations Browses pending invitations to a store, with User Email and Role ID for each.
- List Store Payment Methods Reads payment methods on a store. Use Only Enabled to hide disabled ones and Include Config to add their configuration.
- List Store Payout Processors Shows payout processors set up for a store, by Friendly Name and Payout Methods.
- List Store Payouts Gathers payouts from a store, with Destination and Date for each. Turn on Include Cancelled to see cancelled ones.
- List Store Users Names everyone with access to a store through their Email and Role ID.
- List Stores Returns the stores you can reach, each with its Name and Website.
- List Users Pulls the user accounts on the server, with Email and Name.
- List Wallet Coins Lists unspent outputs in a store wallet, with Amount, Outpoint and Key Path for each.
- List Wallet Transactions Browses on-chain transactions from a store wallet. Filter by Status or by Label, and set Limit to read fewer.
- List Webhook Deliveries Reads recent deliveries of a webhook. Use Count to choose how many of the latest to read.
- List Webhooks Collects webhooks configured in a store, giving URL and Authorized Events.
- Preview a Rate Configuration Tests rate settings before saving them. Try a Spread (%), Preferred Source or Custom Script, then read the rates for Currency Pairs.
- Activate an Invoice Payment Method Turns on one payment method of an invoice, such as BTC-CHAIN or BTC-LN, for payment.
- Add a Store User Gives a user access to a store through a Role. Name the user by id or email, and turn on Require Invitation to send an invitation first.
- Approve a Payout Approves a pending payout. Use Revision to guard against edits made meanwhile and Rate Rule to convert with a custom rate. A failed approval is not retried automatically.
- Approve a User Approves a user account on the server. Turn off Approved to withdraw an approval again.
- Archive a Payment Request Archives a payment request of a store so it is taken out of the active ones.
- Archive a Pull Payment Stops further claims on a pull payment by archiving it.
- Archive an Invoice Hides an invoice from the default invoice lists.
- Broadcast a Wallet Transaction Sends a signed Transaction in raw form to the network through the on-chain Payment Method of a store. Failures here are not retried automatically.
- Cancel a Payout Cancels a payout that has not been sent yet.
- Cancel a Store Invitation Withdraws a pending invitation to a store.
- Connect to a Lightning Peer Joins a Lightning node, either the server node or a store node, to another peer. Write the peer address as nodeid@host:port.
- Create a Lightning Invoice Creates a BOLT11 invoice on a Lightning node for an Amount (millisats). Use Expiry (seconds) to set its lifetime and Private Route Hints to include private channels.
- Create a Payment Request Issues a request for payment in a store using a Title and an Amount. Add an Expiry Date, a Reference ID or Allow Custom Payment Amounts.
- Create a Pull Payment Sets up a pull payment of a total Amount in a Currency. Use Payout Methods to limit how claims are paid and Auto Approve Claims to skip manual approval. A failed setup is not retried automatically.
- Create a Pull Payment Payout Claims a payout against a pull payment, sent to a Destination through a Payout Method ID. Leave Amount empty to claim the rest. A failed claim is not retried automatically.
- Create a Store Starts a store named Name. Set Website, Default Currency or Brand Color to shape how it looks and behaves.
- Create a Store Payout Queues a payout out of store funds to a Destination for an Amount. Turn on Approved to approve it at once, or attach it to a Pull Payment ID. A failed attempt is not retried automatically.
- Create a User Creates an account from an Email. Use Password to set one, Is Administrator for admin rights and Send Invitation Email to invite the user.
- Create a Wallet Transaction Builds an on-chain transaction to Destinations. By default it signs and BROADCASTS it, which spends funds. Turn off Broadcast to avoid sending. A failed run is not retried automatically.
- Create a Webhook Makes BTCPay Server call an Endpoint URL when store events occur. Use Events to restrict which, and Secret to sign every delivery.
- Create an API Key Makes an API key for your own account. Use Label to name it and Permissions to restrict what it can do. You read the API Key value once.
- Create an API Key for a User Makes an API key on behalf of another user. Use Label to name it and Permissions to limit the access it grants.
- Create an App Attaches an app to a store under an App Name, of a chosen App Type. Use Notification URL to receive payment notices.
- Create an Invoice Issues an invoice in a store for an Amount and Currency. Set Buyer Email to tie it to a customer and Order ID to match your own order. If the run fails, it is not retried automatically.
- Create an Offering Adds a subscription offering to a store under a Name. Use Features for a JSON list and Success Redirect URL to send customers elsewhere after signing up.
- Create an Offering Plan Adds a plan to a subscription Offering with a Name, Price and Currency. Use Recurring Type to set the renewal cycle and Trial Days for a free start.
- Delete a File Deletes an uploaded file on BTCPay Server.
- Delete a Notification Removes one notification from your inbox.
- Delete a Store Removes a store from BTCPay Server.
- Delete a Store Payment Method Disconnects a payment option from your store.
- Delete a Subscriber Deletes one subscriber of an offering. Use Customer Selector to say which.
- Delete a User Deletes a BTCPay Server user account.
- Delete a Webhook Detaches a webhook from a store.
- Delete an App Deletes an app from a store in BTCPay Server.
- Delete the Current User Deletes the account of the user that owns the credential. Turn on Confirm Deletion to proceed.
- Link a Boltcard Links a Boltcard to a pull payment by Card UID. Use If Already Linked to decide what happens to a card that is already set up.
- Lock a User Locks a user account on the server. Turn off Locked to unlock it again.
- Make an API Call Sends a free-form request to the BTCPay Server REST API, signed with your saved credential.
- Mark a Payout Sets a payout to a State. Use Payment Proof to attach a JSON object of proof. Errors in this step are not retried automatically.
- Mark a Payout as Paid Records that a payout was paid outside BTCPay Server. A failed run is not retried automatically.
- Mark an Invoice Status Forces an invoice to settled or invalid, depending on the Status set. A failed status change is not retried automatically.
- Open a Lightning Channel Opens a channel from a Lightning node to a peer, funded with Channel Amount (sats). Use Fee Rate (sat/vB) to set the opening fee. An opening that fails is not retried automatically.
- Pay a Lightning Invoice Settles a BOLT11 Invoice using a Lightning node. Cap routing costs with Max Fee (%) or Max Fee (flat). A payment that fails is not retried automatically.
- Pay a Payment Request Creates the invoice that settles a payment request. Use Amount for a custom sum and Allow Pending Invoice Reuse to reuse an unpaid one.
- Redeliver a Webhook Delivery Sends a webhook delivery again to its endpoint as a new attempt.
- Refund an Invoice Starts a refund pull payment for an invoice. Choose a Refund Variant, hold back a Subtract Percentage or set a Custom Amount. A failed refund is not retried automatically.
- Release a Wallet Receive Address Frees the last receive address of a store wallet for reuse.
- Remove a Lightning Address Deletes a Lightning address from your store by Username.
- Remove a Store User Revokes store access from one of its current users.
- Resend a Store Invitation Sends the invitation email for a pending store invitation once more, which gives a fresh Token and Link.
- Revoke an API Key Invalidates an API key by its id.
- Revoke an API Key of a User Cancels an API key that belongs to another user.
- Revoke the Current API Key Ends the key this credential uses. Turn on Confirm Revocation to proceed, since later calls with it fail.
- Run a Report Runs a report query in a store and reads its Data and Fields. Use Search to give the query.
- Save a Lightning Address Creates or replaces a Lightning address for a store under a Username. Use Minimum, Maximum and Invoice Metadata to shape the invoices it issues.
- Send a Store Email Sends an email from a store through its SMTP settings to a recipient, with a Subject and an HTML Body.
- Suspend a Subscriber Suspends a subscriber of an offering. Use Reason to record why it happened.
- Unarchive an Invoice Brings an archived invoice back into the default lists.
- Unsuspend a Subscriber Lifts the suspension of a subscriber so the subscription runs again.
- Update a Notification Marks a notification as read or unread through Seen.
- Update a Payment Request Modifies a payment request, such as its Title, Amount, Expiry Date or Reference ID.
- Update a Rate Configuration Saves rate settings for a store. Set a Spread (%), a Preferred Source or a Custom Script.
- Update a Store Adjusts store settings such as Name, Website, Brand Color or Logo URL.
- Update a Store Payment Method Turns a payment method on or off with Enabled and changes its settings through Config.
- Update a Store User Gives a user another Role in a store, replacing the previous one.
- Update a Subscriber Credit Adds credit with Credit or takes it with Charge for a subscriber. Add a Description for the ledger entry. A failed adjustment is not retried automatically.
- Update a Wallet Transaction Edits a wallet transaction by setting a new Comment or replacing its Labels.
- Update a Webhook Edits a webhook. Change its Endpoint URL, turn Enabled on or off, or set a new Secret.
- Update an App Changes an app. Rename it with App Name, edit its Title or Description, or empty fields through Clear Fields.
- Update an Invoice Replaces the Metadata of an invoice. Turn on Merge With Stored Metadata to keep what is already there.
- Update an Offering Changes an offering through its Name, Success Redirect URL, Metadata or Features.
- Update an Offering Plan Edits a plan, setting a new Name, Price, Currency, Recurring Type or Trial Days.
- Update Notification Settings Switches notification types on or off. Use Turn On and Turn Off with their identifiers.
- Update Store Email Settings Sets the SMTP details for store emails: SMTP Server, Port, Login and From Address. Turn on Disable Certificate Check to skip the TLS check.
- Update Subscriber Dates Moves the Start Date or the Expiration Date of a subscriber to new values.
- Update the Current User Edits your own account, changing Email, Name or Image URL. Changing the password needs Current Password.
- Upload a File Uploads a File to BTCPay Server under a File Name with its extension.
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.
STEP 1
Select BTCPay Server in workflow
Add the "Watch Events" trigger from BTCPay Server to the canvas[4].
STEP 2
Connect BTCPay Server
Fill in the BTCPay Server credential once. All 149 BTCPay Server modules use it[3].
STEP 3
Build a workflow
Add "Get a File" or "Get a Lightning Address" after it, then connect any app[5] or the HTTP node.
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 documentationThe 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
••••••••
| Field | Type | Help |
|---|---|---|
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
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].
References
List of sources used to gather information about the BTCPay Server integration.
- BTCPay Server integration source code, module specs and credentials implementation.
- Internal BTCPay Server integration documentation, structured input and output parameters, scopes, and authentication methods.
- Official BTCPay Server vendor API documentation, used to verify field meanings, authentication flows, and anything our own specs don't fully capture.
- WEXTL® Visual Workflow Builder, anonymized data from our technical support team.
- WEXTL® Apps Library
- WEXTL® BTCPay Server App Documentation
- WEXTL® Workflow Scheduler
- 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.





















