Skip to content

List All Webhooks

Returns a paginated list of the webhooks configured on the current authenticated account. The list is sorted, with the most recent webhooks appearing first by default.

Required scope (OAuth only): view-webhooks

Parameters

ParameterTypeDescription
sort_fieldstring optionalField you want to sort by. Defaults to created_at.
sort_orderstring optionalSorting order, asc or desc. Defaults to desc.
pageinteger optionalPage number. Defaults to 1.
limitinteger optionalPage size. Defaults to 10, capped at 50.

Returns

Returns a paginated collection of webhook objects. If no webhooks are configured, returns an empty collection.

Request

Endpoint: https://youcanpay.com/api/v2/webhooksMethod: GET

bash
$ curl --location -g --request GET 'https://youcanpay.com/api/v2/webhooks' \
  --header 'Accept: application/json' \
  -u 'YOUR_PRIVATE_KEY:'

Response

json
{
  "object": "v2.webhook",
  "data": [
    {
      "object": "v2.webhook",
      "id": "9b1f2c34-5d6e-4a7b-8c9d-0e1f2a3b4c5d",
      "url": "https://example.com/webhooks/youcan-pay",
      "is_live_mode": true,
      "enabled_events": "[\"transaction.paid\",\"transaction.refunded\"]",
      "created_at": "2026-09-09 11:04:22"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total": 1,
    "last_page": 1
  }
}

See the Webhook object for a description of each field.