Show Webhook

GET

/webhooks/{webhook_id}

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

Path 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/' \
--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": "CANCELLED",
        "response_status_code": 200,
        "event_type": "payto_payment.cleared",
        "event_ref_id": "94968d84-6551-446d-9ceb-bad3ca62e8b7",
        "webhook_date": "2024-02-16T14:30:22",
        "payload": {
            "uuid": "ad9234b0-0a5b-4078-9d7f-115b819c636f",
            "reference": "Loan1337-1",
            "agreement_uuid": "2e9d9df0-5c70-4bdf-b031-1caa64121602",
            "amount": 10000,
            "priority": "unattended",
            "statement_reference": "Loan #1337",
            "statement_description": "Loan Payment 1 of 10",
            "last_payment": true,
            "payment_date": "2024-02-01"
        },
        "webhook_request_date": "2024-02-16T14:30:24",
        "webhook_request_body": "{\\\"data\\\":{\\\"webhook_id\\\":\\\"2b4288d1-ad24-4e02-8916-0f5694a40ff7\\\",\\\"webhook_subscription_id\\\":\\\"7e9f4299-6049-4c11-abed-dcdb27102e33\\\",\\\"event_type\\\":\\\"payid.failed\\\",\\\"event_ref_id\\\":\\\"94968d84-6551-446d-9ceb-bad3ca62e8b7\\\",\\\"webhook_date\\\":\\\"2024-02-16T14:30:22\\\",\\\"payload\\\":{\\\"uuid\\\":\\\"c83fa816-6d71-4aae-b6be-44e7124468b7\\\",\\\"reference\\\":\\\"Loan1337-1\\\",\\\"agreement_uuid\\\":\\\"2e9d9df0-5c70-4bdf-b031-1caa64121602\\\",\\\"amount\\\":10000,\\\"priority\\\":\\\"unattended\\\",\\\"statement_reference\\\":\\\"Loan #1337\\\",\\\"statement_description\\\":\\\"Loan Payment 1 of 10\\\",\\\"last_payment\\\":true,\\\"payment_date\\\":\\\"2024-02-01\\\"}}}",
        "webhook_request_headers": {
            "Content-Type": "application/json",
            "X-Signature-SHA256": "LfqR8ybCT0ZIINMMZVc2KBfei8t3JXnGzu8f+3suvSw=",
            "X-Signature-Timestamp": "1685865753"
        },
        "webhook_response_date": "2024-02-16T14:30:25",
        "webhook_response_body": "{\\\"success\\\":true}",
        "webhook_response_headers": null
    }
}

🟠401Unauthorised

🟠404Not Found

🔴500Server Error

Modified at 2024-08-24 12:53:02

List Webhooks

Resend Webhook