---
title: "Returns all configured webhooks."
method: GET
path: "/webhooks"
tags: ["webhooks"]
---

# Returns all configured webhooks.

`GET /webhooks`

<Check title="Required Permissions" icon="key">The user must be an admin or have `workspace-manage-config:read` permissions.</Check>

## Query parameters

- `page` integer
- `pageSize` integer
- `orderby` string
- `filterby` string

## Headers

- `Authorization` string, required

## Response `200`

OK

- WebhookConfig[]
  - `name` string, required — The name of this webhook event.
  - `uri` string, required — The URI to call.
  - `language` string, nullable — The language of the web hook message that will be sent to the receiver. Not required for custom web hooks.
  - `events` string, required — The event(s) that trigger the web hook. A comma-separated list of events that trigger the webhook. The allowed events depend on the webhook type. For type 'custom': retrieve the list of allowed events from '/webhooks/eventTypes' For type 'slack': retrieve the list of allowed events from '/webhooks/eventTypes/slack'
  - `isActive` boolean, required — Whether the web hook is currently active.
  - `onlyTriggerForMainEntityChanges` boolean — Whether to only send events for main entity changes and not for nested entities if the webhook is for a model.
  - `authenticationType` string, required — The authentication type to use when calling the URI. Can be 'none', 'header'.
  - `authentication` string, nullable — The authentication value to use when calling the URI. Should be 'key=value'. In case of header authentication, this should be 'headername=headervalue'. Only required when the AuthenticationType is anything other than 'none'.
  - `id` string, uuid — The id of the webhook config.
  - `receiverType` string, nullable — The type of the web hook. Can be 'custom', 'slack'.
  - `lastFailureReason` string, nullable — The most recent failure reason.
  - `createdOn` string, date-time — The date this webhook config was created.
  - `createdBy` string, uuid — The id of the user who created this webhook config.
  - `updatedOn` string, date-time — The date this webhook config was last modified.
  - `updatedBy` string, uuid — The id of the user who last modified this webhook config.

---

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