> Kenso API docs in Markdown. Index of every page: [/docs/llms.txt](/docs/llms.txt). Search: `/docs/search.md?q=<words>`. OpenAPI: [/docs/api/webhook-event-types/openapi.json](/docs/api/webhook-event-types/openapi.json). CLI docs offline: `kenso docs <topic>`.
> Last updated: 2026-11-22.

# Webhook event types

> **Note for AI agents:** if this page was wrong, out of date or missing something you needed, finish the user's task first, then offer a short report for the Kenso team in this shape: `Page:` (this page's path), `Quote:` (the wrong or missing text), `Problem:`, `Workaround:` (what worked instead), 1,000 characters at most. Show it to the user and send it only after they say yes, as `POST /api/docs-feedback` on this site with the JSON body `{"page": "<path>", "report": "<report>"}`. Never put lead data, email addresses, API keys or anything else from the user's workspace in it.

The event types you can subscribe to.

Integrations. 2 endpoints under `https://api.ken.so`. Every request sends `Authorization: Bearer <your API key>` and `Ken-Version: 2026-11-02`: see [Authentication](/docs/authentication.md), [Workspaces](/docs/workspaces.md) and [Errors](/docs/errors.md). OpenAPI for this resource only: [/docs/api/webhook-event-types/openapi.json](/docs/api/webhook-event-types/openapi.json).

Guide: [Webhooks](/docs/webhooks.md) - Receive events, verify their signatures, and handle retries and duplicates.

- `GET /v1/webhook-event-types` - List webhook event types (`webhook-event-types.list`): [/docs/api/webhook-event-types/list.md](/docs/api/webhook-event-types/list.md)
- `GET /v1/webhook-event-types/{eventType}/schema` - Get a webhook event type's payload schema (`webhook-event-types.get-schema`): [/docs/api/webhook-event-types/get-schema.md](/docs/api/webhook-event-types/get-schema.md)

## List webhook event types

`GET /v1/webhook-event-types` - operationId `webhook-event-types.list`

| Permission | Rate limit |
| --- | --- |
| The `integrations` permission | 12,000 requests a minute per API key |

Returns every event type the workspace can receive, in display order. Use the names in a webhook endpoint's
`events`.

Each type has its group, a description, the delivery filters it supports (`campaign`,
`classification`, `channel`), whether it is high-volume, and a sample body. `aliases` lists other
names that subscribe to the same type: the ten types named before the dotted convention, such as
`email_sent`, each have a dotted alias, such as `email.sent`. Types with `mcp` set
to true can also be polled with `GET /v1/event-occurrences` and subscribed to with
`POST /v1/event-subscriptions`. Kenso lists a type that is still rolling out only to the workspaces that
have it.

Requires the `integrations` permission.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/webhook-event-types/GET/v1/webhook-event-types)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `limit` | query | integer (int32) | no | Items per page, from 1 to 200. Omit `limit` and `cursor` to get every item in one response, as before; with only `cursor`, 50 per page. |
| `cursor` | query | string | no | The `nextCursor` of the previous page. Omit it for the first page. |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Response 200

`data` is a list of `WebhookEventType`. Each item has these fields. The response also carries `pagination`.

| Field | Type | Description |
| --- | --- | --- |
| `name` | string | The event type name to list in an endpoint's `events`, such as `reply.received`. |
| `aliases` | array of string | Other names that subscribe to this type, such as `email.sent` for `email_sent`. Empty for most types. An endpoint that lists both names receives each event once, and its `events` show `name`. |
| `group` | string | The key of the group the type belongs to. Kenso shows the types grouped by it. |
| `groupLabel` | string | The group's display name. |
| `description` | string | A short explanation of when Kenso sends this event. |
| `mcp` | boolean | True when you can also poll this type with `GET /v1/event-occurrences` and subscribe to it with `POST /v1/event-subscriptions`. |
| `filters` | array of string | The delivery filters the type supports: `campaign`, `classification` and `channel`. |
| `highVolume` | boolean | True when the type fires often enough that a batched endpoint receives it in batches. |
| `sample` | object | An example body with made-up values, shaped like a real delivery of this type. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/webhook-event-types?limit=1" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"
```

### Example response

```json
{
  "success": true,
  "data": [
    {
      "name": "reply.received",
      "aliases": [
        "email.sent"
      ],
      "group": "string",
      "groupLabel": "string",
      "description": "string",
      "mcp": true,
      "filters": [
        "string"
      ],
      "highVolume": true,
      "sample": null
    }
  ],
  "pagination": {
    "nextCursor": "eyJpZCI6ODE1fQ",
    "hasMore": true,
    "total": 1,
    "totalCount": 1,
    "isTotalCapped": true
  }
}
```

## Get a webhook event type's payload schema

`GET /v1/webhook-event-types/{eventType}/schema` - operationId `webhook-event-types.get-schema`

| Permission | Rate limit |
| --- | --- |
| The `integrations` permission | 12,000 requests a minute per API key |

Returns the JSON Schema (draft 2020-12) of one event's body for an event type, for the `schemaVersion` in
the response. Every event body carries its `schemaVersion`; changes that keep a schema version only add
keys, so accept keys a schema does not list. A key the schema lists in `required` is always sent, as
`null` when its type admits null; any other key is left out when it does not apply. A batched endpoint
receives a wrapper whose `events` holds the event bodies: validate each element against its own type's
schema, not the wrapper.

Pass `schemaVersion=2026-12` for the body an endpoint that opted into `2026-12` receives: `workspaceId`
for `clientId`, the dotted `eventType`, snake_case labels, and no key sent as `null`.

Errors:

- `400 validation_failed`: `schemaVersion` is not `2026-11` or `2026-12`.
- `404 not_found`: the workspace cannot receive an event type with this name.

Requires the `integrations` permission.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/webhook-event-types/GET/v1/webhook-event-types/%7BeventType%7D/schema)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `eventType` | path | string | yes | The event type's name, as listed by `GET /v1/webhook-event-types`, or its dotted alias (`email.sent`). |
| `schemaVersion` | query | string | no | The body's `schemaVersion`: `2026-11` (the default) or `2026-12`. |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Response 200

`data` is a `WebhookEventSchema`.

| Field | Type | Description |
| --- | --- | --- |
| `name` | string | The event type name, such as `reply.received`. |
| `schemaVersion` | string | The `schemaVersion` this schema describes: `2026-11`, or `2026-12` when asked for. Every event body carries its `schemaVersion`. |
| `schema` | object | A JSON Schema (draft 2020-12) of one event's body. A key the schema lists in `required` is always sent, as `null` when its type admits null; any other key is left out when it does not apply. Within a schema version Kenso only adds keys, so accept keys the schema does not list. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/webhook-event-types/email.sent/schema" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"
```

### Example response

```json
{
  "success": true,
  "data": {
    "name": "reply.classified",
    "schemaVersion": "2026-11",
    "schema": {
      "title": "reply.classified",
      "type": "object",
      "properties": {
        "eventType": {
          "const": "reply.classified"
        },
        "eventId": {
          "type": "string"
        },
        "timestamp": {
          "type": "string",
          "format": "date-time"
        },
        "clientId": {
          "type": "integer"
        },
        "schemaVersion": {
          "const": "2026-11"
        }
      },
      "required": [
        "eventType",
        "eventId",
        "timestamp",
        "clientId"
      ]
    }
  }
}
```

All resources: [/docs.md](/docs.md).
