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

# List Webhooks

`GET /webhooks`

List all webhook endpoints.

## Query parameters

- `size` integer
- `cursor` string

## Response `200`

OK

- WebhookListResponse
  - `code` 'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED' — Request status code
  - `message` string — Message response to the request
  - `requestId` string — Unique ID that is added to the body of every response for easy traceability of the request in our logs.
  - `data` object
    - `nextCursor` string — The next cursor value that can be used in the following query.
    - `items` Webhook[]
      - `id` string, required — Unique ID of this object
      - `createdAt` string, date-time, required — Date and time
      - `name` string, required — Name of the webhook endpoint
      - `url` string, required — URL of webhook, must begin with https://
      - `secret` string — The key that will be used to generate HMAC-SHA512 hex digest value in the Smile-Signature header.
      - `eventTypes` RefWebhookEventType[], required — Special events that you want to subscribe to
      - `active` boolean, required — Set to true or false depending on if you would like to enable this webhook or not
      - `includePayload` boolean — Whether to put all datapoints' payload into the events(TASK_FINISHED_EVENT, ACCOUNT_SNYC_TASK_FINISHED_EVENT)
      - `updatedAt` string, date-time, required — Date and time

---

[API](https://skmtc.net/smileapi/apis/smile-api.md) · [All operations](https://skmtc.net/smileapi/apis/smile-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smileapi/smile-api/versions/d1e0cb5dc33c/schema)