Squarepay API
  1. Webhook Subscriptions
Squarepay API
  • Authentication
    • Test Authentication
      POST
  • PayTo
    • Agreements
      • Create Agreement
      • List Agreements
      • Show Agreement
      • Show Agreement History
    • Agreement Actions
      • Cancel Agreement
    • Payments
      • Create Payment
      • List Payments
      • Show Payment
      • Retry Payment
  • Webhook Subscriptions
    • Create Webhook Subscription
      POST
    • List Webhook Subscriptions
      GET
    • Update Webhook Subscription
      PUT
    • Delete Webhook Subscription
      DELETE
  • Webhooks
    • List Webhooks
      GET
    • Show Webhook
      GET
    • Resend Webhook
      POST
  1. Webhook Subscriptions

List Webhook Subscriptions

GET
/webhook-subscriptions

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api-sandbox.squarepay.com.au/v2/webhook-subscriptions' \
--header 'Accept: application/json' \
--header 'Authorization: Basic Og=='

Responses

🟢200OK
application/json
Body

Example
{
    "data": [
        {
            "webhook_subscription_id": "7e9f4299-6049-4c11-abed-dcdb27102e33",
            "url": "https://webhook.site/some-uuid",
            "signature_secret": "YpG4przYWpXqn7Q6pw16G2D47762UhF0LcLlBjn59oMDOh7SfujaV6EcgOd6merv",
            "events": [
                "payto_agreement.activated",
                "payto_payment.cleared"
            ],
            "status": "ACTIVE"
        }
    ]
}
🟠401Unauthorised
🔴500Server Error
Modified at 2024-08-24 12:01:33
Previous
Create Webhook Subscription
Next
Update Webhook Subscription
Built with