Skip to main content

WebhooksListResponse

pageinteger

The current pagination page

perPageinteger

The requested number of entries per page

lastPageinteger

The last page with entries

totalinteger

The total number of entries

firstPageUrlstring

URL for the first page

lastPageUrlstring

URL for the last page

nextPageUrlstringnullable

URL for the next page

previousPageUrlstringnullable

URL for the previous page

nextPageintegernullable

The page number for the next page. Null if no next page.

previousPageintegernullable

The page number for the previous page. Null if no previous page.

frominteger

The entry offset for the first entry in the page

tointeger

The entry offset for the last entry in the page

pathstring

The path for the pagination endpoint

items object[]

The page contents

  • Array [
  • iduuidrequired

    Unique identifier of the webhook.

    urlurirequired

    Destination URL configured for webhook delivery.

    eventsstring[]required

    Events the webhook is subscribed to.

    Possible values: [subscription-billing.charge-failed.v1, subscription-billing.charge-success.v1, subscription-billing.agreement-active.v1, subscription-billing.agreement-stopped.v1]

    createdAtdate-timerequired

    Timestamp when the webhook was created.

  • ]
  • WebhooksListResponse
    {
    "page": 0,
    "perPage": 0,
    "lastPage": 0,
    "total": 0,
    "firstPageUrl": "string",
    "lastPageUrl": "string",
    "nextPageUrl": "string",
    "previousPageUrl": "string",
    "nextPage": 0,
    "previousPage": 0,
    "from": 0,
    "to": 0,
    "path": "string",
    "items": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "url": "string",
    "events": [
    "subscription-billing.charge-failed.v1"
    ],
    "createdAt": "2024-07-29T15:51:28.071Z"
    }
    ]
    }