v1
latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MBList all webhooks
Returns a paginated list of your webhooks. If no webhook endpoints are available, the resulting array will be empty. This request should never throw an error.
🔑 Access with
Advanced access token with webhooks.read
OAuth access with webhooks.read
Query parameters
Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.
The maximum number of items to return. Defaults to 50 items.
Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.
Possible values: asc desc
The list of events to enable for this webhook. You may specify '*' to add all events, except those that require explicit selection.
Possible values: payment.paid payment.authorized payment.failed payment.canceled payment.expired payment.pending refund.queued refund.pending refund.processing refund.refunded refund.failed refund.canceled chargeback.received chargeback.reversed capture.succeeded capture.failed payment-link.paid balance-transaction.created payout.initiated payout.processing-at-bank payout.completed payout.canceled payout.failed sales-invoice.created sales-invoice.issued sales-invoice.canceled sales-invoice.paid sales-invoice.e-invoice-failed sales-invoice.e-invoice-issued business-account-transfer.requested business-account-transfer.initiated business-account-transfer.pending-review business-account-transfer.processed business-account-transfer.failed business-account-transfer.blocked business-account-transfer.returned *
Used to filter out only the webhooks that are subscribed to certain types of events.
Possible values: payment.paid payment.authorized payment.failed payment.canceled payment.expired payment.pending refund.queued refund.pending refund.processing refund.refunded refund.failed refund.canceled chargeback.received chargeback.reversed capture.succeeded capture.failed payment-link.paid balance-transaction.created payout.initiated payout.processing-at-bank payout.completed payout.canceled payout.failed sales-invoice.created sales-invoice.issued sales-invoice.canceled sales-invoice.paid sales-invoice.e-invoice-failed sales-invoice.e-invoice-issued business-account-transfer.requested business-account-transfer.initiated business-account-transfer.pending-review business-account-transfer.processed business-account-transfer.failed business-account-transfer.blocked business-account-transfer.returned *
You can enable test mode by setting the testmode query parameter to true.
Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
Response
A list of webhooks. For a complete reference of the webhook object, refer to the Get hook endpoint documentation.