Skip to content

Latest commit

 

History

History
48 lines (38 loc) · 1.53 KB

update-webhook-subscription-response.md

File metadata and controls

48 lines (38 loc) · 1.53 KB

Update Webhook Subscription Response

Defines the fields that are included in the response body of a request to the UpdateWebhookSubscription endpoint.

Note: If there are errors processing the request, the Subscription is not present.

Structure

UpdateWebhookSubscriptionResponse

Fields

Name Type Tags Description Getter
Errors List<Error> Optional Information on errors encountered during the request. List getErrors()
Subscription WebhookSubscription Optional Represents the details of a webhook subscription, including notification URL,
event types, and signature key.
WebhookSubscription getSubscription()

Example (as JSON)

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