• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Retrieve webhook subscription BETA

GET /v2/webhooks/subscriptions/{subscription_id}

Retrieves a webhook subscription identified by its ID.

Name Description
subscription_id
string

Required

[REQUIRED] The ID of the Subscription to retrieve.

Response Fields

Name Description
errors
Error [ ]

Information on errors encountered during the request.

subscription
WebhookSubscription

The requested Subscription.

Examples

You are viewing an old version of the API
GET /v2/webhooks/subscriptions/{subscription_id}
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/webhooks/subscriptions/wbhk_b35f6b3145074cf9ad513610786c19d5 \
  -H 'Square-Version: 2022-11-16' \
  -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"
  }
}