---
title: "List all webhook subscriptions"
method: GET
path: "/webhooks"
tags: ["Webhook Subscriptions"]
---

# List all webhook subscriptions

`GET /webhooks`

Returns a list of all webhook subscriptions.

## Query parameters

- `sort` 'created_at' | 'updated_at' | 'title' | 'url' | 'enabled'
- `order` 'ASC' | 'DESC'
- `offset` integer
- `limit` integer

## Response `200`

An object with a data property that contains an array of webhook subscription objects.

- object
  - `meta` object, required
    - `offset` integer, required — Amount of resource to offset in the response.
    - `limit` integer, required — Total limit of the response.
    - `count` integer, required — Count of the resources returned in the response.
    - `total_count` integer, required — Total count of all the resources.
    - `sort` string — The field that the list is sorted by.
    - `order` 'ASC' | 'DESC' — The ordering of the response. * ASC - Ascending order * DESC - Descending order
  - `data` object[], required
    - `id` string, uuid, required — Webhook unique identifier.
    - `created_at` string, date-time, required — Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
    - `updated_at` string, date-time, required — Date and time when the resource was last updated. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
    - `title` string, required — Title of the webhook for use on tenant side.
    - `url` string, url, required — The callback URL to be called by the webhook.
    - `enabled` boolean, required — Enable/disable webhook.
    - `type` string[], required — What kind of events to be sent by the webhook.
    - `exclude_type` string[] — What kind of events to be excluded if subscription type is: ALL.
    - `config` object, required — Configuration of webhook packages collection.
      - `delay` string — Maximum time of package collection (1s-30s).
      - `max_package_size` integer — Maximum package size (bytes)

## Other responses

- `400` — Bad Request. The incoming request had a malformed parameter/object.
- `401` — Unauthorized. The caller has not been authenticated.
- `403` — Forbidden. The caller has been authenticated but is not allowed to take the requested action.
- `406` — Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
- `429` — Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
- `500` — Internal Server Error. The service encountered an unexpected error.
- `503` — Service Unavailable. The service handling for this request cannot be reached at this time.
- `504` — Gateway Timeout. The service gateway has reached its internal timeout.

---

[API](https://skmtc.net/upvest/apis/upvest-investment-api.md) · [All operations](https://skmtc.net/upvest/apis/upvest-investment-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/upvest/upvest-investment-api/revisions/eb94c0091916/schema)