# BTCPay Server Webhooks API

**Canonical:** https://apis.io/apis/btcpay/btcpay-webhooks-api/  
**Provider:** BTCPay Server — https://apis.io/providers/btcpay/  
**Base URL:** https://{btcpay-host}/api/v1  
**Documentation:** https://docs.btcpayserver.org/API/Greenfield/v1/

BTCPay Server Webhooks API is one of 31 APIs that [BTCPay Server](https://apis.io/providers/btcpay/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, authentication docs, and rate-limit docs.

Webhook operations

## Machine-readable artifacts (9)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/openapi/btcpay-webhooks-api-openapi.yml
- **Documentation** — https://docs.btcpayserver.org/API/Greenfield/v1/
- **JSONLD** — https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
- **Vocabulary** — https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
- **GitHubRepository** — https://github.com/btcpayserver/btcpayserver
- **Authentication** — https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
- **Plans** — https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
- **FinOps** — https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml

## Other BTCPay Server APIs (12)

- [BTCPay Server API Keys API](https://apis.io/apis/btcpay/btcpay-api-keys-api/)
- [BTCPay Server Apps API](https://apis.io/apis/btcpay/btcpay-apps-api/)
- [BTCPay Server Authorization API](https://apis.io/apis/btcpay/btcpay-authorization-api/)
- [BTCPay Server Crowdfund API](https://apis.io/apis/btcpay/btcpay-crowdfund-api/)
- [BTCPay Server Files API](https://apis.io/apis/btcpay/btcpay-files-api/)
- [BTCPay Server Health API](https://apis.io/apis/btcpay/btcpay-health-api/)
- [BTCPay Server Invoices API](https://apis.io/apis/btcpay/btcpay-invoices-api/)
- [BTCPay Server Lightning address API](https://apis.io/apis/btcpay/btcpay-lightning-address-api/)
- [BTCPay Server Lightning (Internal Node) API](https://apis.io/apis/btcpay/btcpay-lightning-internal-node-api/)
- [BTCPay Server Lightning (Store) API](https://apis.io/apis/btcpay/btcpay-lightning-store-api/)
- [BTCPay Server Miscelleneous API](https://apis.io/apis/btcpay/btcpay-miscelleneous-api/)
- [BTCPay Server Notifications (Current User) API](https://apis.io/apis/btcpay/btcpay-notifications-current-user-api/)

## Tags

Webhook

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/btcpay/btcpay-webhooks-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/btcpay/.