---
title: "List webhooks"
method: GET
path: "/webhooks"
tags: ["Webhooks"]
---

# List webhooks

`GET /webhooks`

Retrieve a list of configured webhooks. The returned list is
[paginated](#pagination) and can be scrolled by following the `next`
and `prev` links where present. Results are ordered oldest first to
newest last.

## Query parameters

- `page[size]` integer

## Response `200`

Successful Response

- ListWebhooksResponse — Successful response to get all webhooks. This returns a paginated list of webhooks, which can be scrolled by following the `prev` and `next` links if present.
  - `data` WebhookResource[], required — The list of webhooks returned in this response.
    - `type` string, required — The type of this resource: `webhooks`
    - `id` string, required — The unique identifier for this webhook.
    - `attributes` object, required
      - `url` string, required — The URL that this webhook is configured to `POST` events to.
      - `description` string, nullable, required — An optional description that was provided at the time the webhook was created.
      - `secretKey` string — A shared secret key used to sign all webhook events sent to the configured webhook URL. This field is returned only once, upon the initial creation of the webhook. If lost, create a new webhook and delete this webhook. The webhook URL receives a request with a `X-Up-Authenticity-Signature` header, which is the SHA-256 HMAC of the entire raw request body signed using this `secretKey`. It is advised to compute and check this signature to verify the authenticity of requests sent to the webhook URL. See [Handling webhook events](#callback_post_webhookURL) for full details.
      - `createdAt` string, date-time, required — The date-time at which this webhook was created.
    - `relationships` object, required
      - `logs` object, required
        - `links` object
          - `related` string, required — The link to retrieve the related resource(s) in this relationship.
    - `links` object
      - `self` string, required — The canonical link to this resource within the API.
  - `links` object, required
    - `prev` string, nullable, required — The link to the previous page in the results. If this value is `null` there is no previous page.
    - `next` string, nullable, required — The link to the next page in the results. If this value is `null` there is no next page.

## Changes

- **2020-07-29** (v1) `48ca1ca58cdd` — 1 info
  - added the required property `data/items/attributes/description` to the response with the `200` status
- **2020-07-26** (v1) `503c1dbaec36` — 1 info
  - added the optional property `data/items/attributes/secretKey` to the response with the `200` status
- **2020-07-21** (v1) `2ac77a5de971` — 1 breaking, 1 warning
  - removed the required property `data/items/attributes/description` from the response with the `200` status
  - removed the optional property `data/items/attributes/secretKey` from the response with the `200` status

[Change history](https://skmtc.dev/up-banking/apis/up-api/changes/webhooks/get.md)

---

[API](https://skmtc.dev/up-banking/apis/up-api.md) · [All operations](https://skmtc.dev/up-banking/apis/up-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/up-banking/up-api/revisions/cc6a5e6d809d/schema)