retrieve-webhook-subscription-response.md

Retrieve Webhook Subscription Response

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

Note: if there are errors processing the request, the Subscription will not be present.

Structure

RetrieveWebhookSubscriptionResponse

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": true,
    "event_types": [
      "payment.created",
      "payment.updated"
    ],
    "id": "wbhk_b35f6b3145074cf9ad513610786c19d5",
    "name": "Example Webhook Subscription",
    "notification_url": "https://example-webhook-url.com",
    "signature_key": "1k9bIJKCeTmSQwyagtNRLg",
    "updated_at": "2022-01-10 23:29:48 +0000 UTC"
  },
  "errors": [
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "INVALID_EXPIRATION",
      "detail": "detail6",
      "field": "field4"
    }
  ]
}