> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cleo-pay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List webhook endpoints

> GET /v1/webhook-endpoints lists the business's webhook endpoints with their status and subscribed event types.

```
GET /v1/webhook-endpoints
```

**Scope:** `webhooks:read`

```bash theme={null}
curl https://api.stg.cleo-pay.com/v1/webhook-endpoints \
  --header "Authorization: Bearer $CLEO_API_KEY"
```

## Response

`200` with `{ items }`. Each item is a webhook endpoint:

<ResponseField name="id" type="string" />

<ResponseField name="url" type="string">The https URL that receives deliveries.</ResponseField>

<ResponseField name="description" type="string | null" />

<ResponseField name="subscribedEventTypes" type="string[]">Event types, for example `payment.failed`, or `["*"]` for all.</ResponseField>
<ResponseField name="status" type="string">`active`, `disabled` or `paused`. Cleo pauses an endpoint after sustained delivery failures.</ResponseField>
<ResponseField name="secretLast4" type="string">Last 4 characters of the signing secret.</ResponseField>

<ResponseField name="disabledAt" type="string | null" />

<ResponseField name="lastSuccessAt" type="string | null" />

<ResponseField name="lastFailureAt" type="string | null" />

<ResponseField name="consecutiveFailureCount" type="integer">Deliveries that failed in a row since the last success.</ResponseField>

<ResponseField name="createdAt" type="string" />

Answers `403 feature_unavailable` until Cleo turns webhooks on for the business.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.