List Webhooks

GET

/webhooks

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 *****************

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api-sandbox.squarepay.com.au/v2/webhooks?webhook_subscription_id=7e9f4299-6049-4c11-abed-dcdb27102e33&webhook_status=FAILED&event_type=payto_payment.cleared&after=2024-02-16&before=2024-02-16&on=2024-02-16&page=1&limit=100' \
--header 'Accept: application/json' \
--header 'Authorization: Basic Og=='

Responses

🟢200OK

application/json

Body

Example

{
    "data": [
        {
            "webhook_id": "2b4288d1-ad24-4e02-8916-0f5694a40ff7",
            "webhook_subscription_id": "7e9f4299-6049-4c11-abed-dcdb27102e33",
            "webhook_status": "SUCCESSFUL",
            "response_status_code": 200,
            "event_type": "payto_payment.cleared",
            "event_ref_id": "94968d84-6551-446d-9ceb-bad3ca62e8b7",
            "webhook_date": "2024-02-16T14:30:22"
        }
    ]
}

🟠401Unauthorised

🟠422Unprocessable Entity

🔴500Server Error

Modified at 2024-08-24 13:04:00

Delete Webhook Subscription

Show Webhook