Update webhook subscription

PUT

/v2/webhooks/subscriptions/{subscription_id}

Updates a webhook subscription.

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 update.

Link to section

Request body

Link to section

subscription

The Subscription to update.

Link to section

Response fields

Link to section

errors

Information on errors encountered during the request.

Link to section

subscription

The updated Subscription.

Link to section

Examples

All versions ->

PUT /v2/webhooks/subscriptions/{subscription_id}

curl https://connect.squareup.com/v2/webhooks/subscriptions/wbhk_b35f6b3145074cf9ad513610786c19d5 \
  -X PUT \
  -H 'Square-Version: 2024-12-18' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "subscription": {
      "name": "Updated Example Webhook Subscription",
      "enabled": false
    }
  }'

Response JSON

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