list-webhook-subscriptions-response.md

List Webhook Subscriptions Response

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

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

Structure

ListWebhookSubscriptionsResponse

Fields

Name	Type	Tags	Description	Getter
Errors	List<Error>	Optional	Information on errors encountered during the request.	List getErrors()
Subscriptions	List<WebhookSubscription>	Optional	The requested list of Subscriptions.	List getSubscriptions()
Cursor	String	Optional	The pagination cursor to be used in a subsequent request. If empty, this is the final response. For more information, see Pagination.	String getCursor()

Example (as JSON)

{
  "subscriptions": [
    {
      "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",
      "updated_at": "2022-01-10 23:29:48 +0000 UTC"
    }
  ],
  "errors": [
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "INVALID_EXPIRATION",
      "detail": "detail6",
      "field": "field4"
    }
  ],
  "cursor": "cursor6"
}