Retrieve webhook subscription

GET

/v2/webhooks/subscriptions/{subscription_id}

Retrieves a webhook subscription identified by its ID.

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

subscription_id

string

Required

[REQUIRED] The ID of the Subscription to retrieve.

Link to section

Response fields

Link to section

errors

Information on errors encountered during the request.

Link to section

subscription

The requested Subscription.

Link to section

Examples

All versions ->

GET /v2/webhooks/subscriptions/{subscription_id}

curl https://connect.squareup.com/v2/webhooks/subscriptions/wbhk_b35f6b3145074cf9ad513610786c19d5 \
  -H 'Square-Version: 2024-12-18' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Response JSON

{
  "subscription": {
    "id": "wbhk_b35f6b3145074cf9ad513610786c19d5",
    "name": "Example Webhook Subscription",
    "enabled": true,
    "event_types": [
      "payment.created",
      "payment.updated"
    ],
    "notification_url": "https://example-webhook-url.com",
    "api_version": "2021-12-15",
    "signature_key": "1k9bIJKCeTmSQwyagtNRLg",
    "created_at": "2022-01-10 23:29:48 +0000 UTC",
    "updated_at": "2022-01-10 23:29:48 +0000 UTC"
  }
}