BTCPay Server and Clientary Integration

Demonstration of how apps are integrated in WEXTL workflow builder[4]

Build finance workflows between BTCPay Server and Clientary on a visual canvas. Set up data fields sync between apps once and let data flow when events come automatically. Integration will work without code and your team will see the workflow inside WEXTL® builder.

  • 3-day trial
  • Cancel anytime
  • Up to 10 minutes quick set up
  • GDPR
  • Data Encryption
  • 2FA
  • Local Data Region

Learn about BTCPay Server and Clientary

Detailed info you need to know about BTCPay Server and Clientary integrations in WEXTL. Explore which modules apps support and how you connect them.

  • BTCPay Server

    • Finance
    • 1 trigger
    • 72 searches
    • 77 actions

    Self-hosted Bitcoin payments: invoices, payment requests, payouts, stores, webhooks and lightning.[5]

  • Clientary

    • Finance
    • 6 triggers
    • 37 searches
    • 59 actions

    Manage clients, estimates, invoices, retainers, projects, time and payments in Clientary.[6]

How to connect BTCPay Server to Clientary

Set up your BTCPay Server and Clientary integration in 3 simple steps[2]. No coding required. Up to 10 minutes setup.

How does the integration between BTCPay Server and Clientary work in WEXTL?

WEXTL exposes actions and triggers for BTCPay Server and Clientary that help you connect apps and automate repetitive tasks[1]. A trigger is an event that happens, and an action is a step that performs when the event has occurred.

BTCPay Server triggersClientary actions

BTCPay Server modules

  • Watch Events Fires instantly when BTCPay Server posts a webhook event. Each run has the Event Type and Delivery ID.
  • 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.
  • 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.

Clientary modules

  • Archive a Recurring Time Entry Archives a recurring time entry. It stops running and disappears from lists, while the time it already logged stays.
  • Charge an Invoice to a Payment Profile Charges the whole outstanding amount of an invoice to a card saved on a client. The result shows the Amount, Received on and Transaction fee amount.
  • Create a Client Starts a client file from a Name. Fill Number with your own unique client number, or include Address, Tax ID, Website and a Note.
  • Create a Comment Posts a Comment on an invoice, estimate, project, task, proposal or contract. Turn on Staff Only to hide it from the client, or supply HTML for rich text.
  • Create a Contact Adds a person to a client with their Name and Email. Fill Phone, Mobile, Title and Extension as well.
  • Create a Contract Drafts a contract for a Client on a Date, as Freeform text or Fees. Write Sections, name Signers, and enable Create Invoice After Signing to bill on signature.
  • Create a Lead Adds a prospect from a Name. Track its worth with Lead Value and Lead Origin, pass it to someone with Assignee, and record Lost Reason when it falls through.
  • Create a Payment Profile Stores a card on a client using its Stripe Customer ID and Stripe Source ID, with the Last Four Digits, Name on Card and Expiration Date.
  • Create a Project Sets up a project priced by Rate. Choose Project Type for hourly or fixed pricing, add a Budget Type and Budget, or pick a Template to copy.
  • Create a Proposal Drafts a proposal for a Client on a Date, as Freeform text or Fees. Write Sections, then add Signers.
  • Create a Recurring Invoice Sets up an invoice that repeats from a Next Date, with a Repeat interval and Due In (Days). Choose Action to send it, save it as a draft or autobill a Payment Profile.
  • Create a Recurring Time Entry Schedules time to be logged again and again from a Next Date, with Hours, a Title and a Repeat interval. Turn on Unlimited to keep going, or set Occurrences Remaining to stop.
  • Create a Retainer Raises a retainer request itemized through Items, with a Client, Date and Currency Code.
  • Create a Task Adds a task titled with Title. Link it to a Project, set an Assignee and Due Date, and write a Description.
  • Create a Time Entry Logs Hours worked on a Project under a Title. Leave Date blank to record the time for today.
  • Create an Estimate Drafts a quote with a Date and Currency Code, priced through Items. Add an Expiration Date or Delivery Date, and leave Number blank to number it automatically.
  • Create an Expense Records an Amount spent, optionally tied to a Client and Project, plus a Description and an Incurred On date.
  • Create an Invoice Raises an invoice for a Date, Due Date and Currency Code, priced through Items. Connect it to earlier work through Linked Estimate ID or Linked Contract ID.
  • Delete a Client Removes a client, returning its Id with Deleted.
  • Delete a Comment Removes a comment from its record. Only the author can do this.
  • Delete a Contact Deletes a contact from a client, returning the Id with Deleted.
  • Delete a Contract Removes a contract, and this cannot be undone.
  • Delete a Lead Removes a lead from Clientary, reporting Deleted.
  • Delete a Payment Deletes a payment recorded against an invoice, and this cannot be undone.
  • Delete a Payment Profile Removes a card saved on a client.
  • Delete a Project Deletes a project along with its tasks, hours and comments. This cannot be undone.
  • Delete a Proposal Removes a proposal in your Clientary workspace.
  • Delete a Recurring Invoice Removes a recurring invoice schedule from Clientary.
  • Delete a Recurring Time Entry Deletes a recurring time entry. Time it already logged is not part of this call.
  • Delete a Retainer Deletes a retainer billed to a client.
  • Delete a Task Deletes a task from the project it belongs to, returning the Id with Deleted.
  • Delete a Time Entry Deletes a logged block of hours, with no way to restore it.
  • Delete an Estimate Removes an estimate and returns its Id with Deleted.
  • Delete an Expense Removes an expense record from your Clientary account.
  • Delete an Invoice Deletes an invoice together with its items and payments. This cannot be undone.
  • Get a Client Opens one client and returns its Number, Name and Address.
  • Get a Contact Reads a contact, including Client id, Name, Email, Phone and Mobile.
  • Get a Contract Fetches a contract showing its Subject, Status, Date and Client id.
  • Get a Lead Shows a prospect with its Number, Name, Address and City.
  • Get a Project Opens a project with its Name, Rate, Status and Budget type.
  • Get a Proposal Reads a proposal and its Subject, Status, Date and Client id.
  • Get a Recurring Invoice Loads a recurring invoice schedule: Number, Next date, Due period and Currency code.
  • Get a Recurring Time Entry Reads a recurring time entry with its Title, Hours, Time interval and Next date.
  • Get a Report Summary Adds up what was Invoiced, Paid and Outstanding from a From Date to a To Date. Add Client to limit the totals to one client.
  • Get a Retainer Opens a retainer and shows its Number, Date and Currency code.
  • Get a Staff User Looks up one team member and returns their Name and Email.
  • Get a Task Fetches a task with its Title, Complete state, Assignee id and Due date.
  • Get a Template Reads one contract, proposal or project template of a Kind. A negative Template ID reads a built-in default.
  • Get a Time Entry Looks up a time entry and returns its Title, Date, Rate and Project id.
  • Get an Estimate Loads an estimate with Number, Date, Currency code and Status.

Explore alternative integrations

There are other apps[9] supported by WEXTL that can be paired with BTCPay Server and Clientary integrations. Pick any from the list below if the current combination isn't the one you need.

Automate BTCPay Server and Clientary on WEXTL®

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

Cancel anytime.

Frequently asked questions

Common questions about connecting BTCPay Server and Clientary.

How do I connect BTCPay Server and Clientary?

Connect your BTCPay Server and Clientary accounts once, pick a trigger in one app and an action in the other, then map the fields so data flows automatically between them.[3]

What can I automate between BTCPay Server and Clientary?

Example: when the "Watch Events" trigger in BTCPay Server fires, WEXTL can "Archive a Recurring Time Entry" in Clientary. BTCPay Server has 1 trigger (including Watch Events). Clientary has 96 actions (including Archive a Recurring Time Entry, Charge an Invoice to a Payment Profile, and Create a Client). Add filters and transforms between steps when you need them.[1]

Can BTCPay Server trigger actions in Clientary, and Clientary in BTCPay Server?

Yes. The integration works in both directions. Use the triggers of each app to start a workflow and the actions of the other app to update it.[2]

Do I need to write code to integrate BTCPay Server and Clientary?

No. BTCPay Server-to-Clientary automations are built visually on the canvas. You can optionally add custom JavaScript with Functions when you need advanced logic.[4]

Does BTCPay Server integrate with Clientary in real time?

Yes. Trigger-based automations start the moment BTCPay Server (or Clientary) fires a new event. Webhook-backed apps run within seconds, and polling-only apps re-check on a schedule you control.[7]

How long does it take to set up a BTCPay Server + Clientary integration?

A first automation typically takes 5–10 minutes: connect the credential of each app once, drop a trigger + action onto the canvas, map the fields, and turn the workflow on.

Do I need a paid plan to connect BTCPay Server with Clientary?

You can build your BTCPay Server + Clientary automation on a 3-day trial with every feature unlocked. Cancel anytime.[8]

References

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

  1. BTCPay Server and Clientary integration source code, module specs and credentials implementation.
  2. Our BTCPay Server and Clientary integration documentation, structured input and output parameters, scopes, and authentication methods.
  3. Official vendor API documentation for BTCPay Server and Clientary, 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. BTCPay Server integration information
  6. Clientary integration information
  7. WEXTL® Scheduling
  8. WEXTL® Pricing and Trial
  9. WEXTL® Apps Library

How we write our apps documentation

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

Explore BTCPay Server and Clientary, or get started