---
title: "Find webhooks"
method: GET
path: "/v1/webhooks"
tags: ["Webhook"]
---

# Find webhooks

`GET /v1/webhooks`

If you would like to use our webhook service, please contact support@encircleapp.com

## Query parameters

- `order` 'newest' | 'oldest'
- `limit` integer
- `after` string, jwt

## Headers

- `X-Encircle-Attribution` string
- `X-Encircle-Request` string

## Response `200`

A list of Webhooks that were created by this authenticated token's Bot.

- object
  - `list` WebhookResponse[], required
    - `id` integer, required — The `id` of the `Webhook`.
    - `delivery_url` string, required — An HTTPS endpoint URL the Webhook will deliver payloads to. The URL should be unique per Organization / bearer token so your system can authenticate any necessary follow-up requests. Your domain must also be whitelisted, contact [support@encircleapp.com](mailto:support@encircleapp.com) If the status code returned by the endpoint is 410, then a resource required to fire the appropriate `Webhook` event is unavailable, at which point the `Webhook` will stop listening for that event.
    - `events` string[], required
    - `authentication` object — Optionally specify an authentication scheme that can be used by third party systems to verify that requests originate from Encircle systems. If you require an authentication type other than shared_secret, please contact support@encircleapp.com
      - `type` 'jwt' | 'oauth' | 'shared_secret', required — The type of authentication this Webhook utilizes. For now, only "shared_secret" can be accessed through the API.
      - `header_name` 'Authorization' | 'ocp-apim-subscription-key', required — The HTTPS header field name whose value will be 'shared_secret'. Permitted values are: "Authorization", "ocp-apim-subscription-key". If this not provided in the request, the default, "Authorization", will be used when event payloads are sent to 'delivery_url'.
      - `shared_secret` string, required — The non-empty string to be included as an `Authorization` header when event payloads are sent to `delivery_url`.
  - `cursor` object, required
    - `order` string, required — Specifies the requested ordering of results. See the `order` query parameter for explanations of all the options.
    - `limit` integer, required — Maximum number of results that were included in this response. See the `limit` query parameter.
    - `after` string, jwt, nullable, required — A string that can be passed as an `after` query parameter to fetch the next page of results. If `null`, it means that there are no further results and that the returned data is the last page.

## Other responses

- `400` — Error processing request.
- `401` — Authentication error.
- `404` — Requested resource does not exist.

---

[API](https://skmtc.net/encircleapp/apis/encircle-public-api.md) · [All operations](https://skmtc.net/encircleapp/apis/encircle-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/encircleapp/encircle-public-api/versions/0e70222a2c6d/schema)