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

# Inbound webhooks

> **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.

Webhook URLs on a campaign that send leads into Kenso from your own tools, with field mapping and recent deliveries.

Integrations. 10 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/inbound-webhooks/openapi.json](/docs/api/inbound-webhooks/openapi.json).

- `GET /v1/campaigns/{campaignId}/inbound-webhooks` - List a campaign's inbound webhooks (`inbound-webhooks.list`): [/docs/api/inbound-webhooks/list.md](/docs/api/inbound-webhooks/list.md)
- `POST /v1/campaigns/{campaignId}/inbound-webhooks` - Create a campaign inbound webhook (`inbound-webhooks.create`): [/docs/api/inbound-webhooks/create.md](/docs/api/inbound-webhooks/create.md)
- `GET /v1/inbound-webhooks/{inboundWebhookId}` - Get an inbound webhook (`inbound-webhooks.get`): [/docs/api/inbound-webhooks/get.md](/docs/api/inbound-webhooks/get.md)
- `PATCH /v1/inbound-webhooks/{inboundWebhookId}` - Update an inbound webhook (`inbound-webhooks.update`): [/docs/api/inbound-webhooks/update.md](/docs/api/inbound-webhooks/update.md)
- `DELETE /v1/inbound-webhooks/{inboundWebhookId}` - Delete an inbound webhook (`inbound-webhooks.delete`): [/docs/api/inbound-webhooks/delete.md](/docs/api/inbound-webhooks/delete.md)
- `GET /v1/inbound-webhooks` - List people webhooks (`inbound-webhooks.list-people-sources`): [/docs/api/inbound-webhooks/list-people-sources.md](/docs/api/inbound-webhooks/list-people-sources.md)
- `POST /v1/inbound-webhooks` - Create a people webhook (`inbound-webhooks.create-people-source`): [/docs/api/inbound-webhooks/create-people-source.md](/docs/api/inbound-webhooks/create-people-source.md)
- `POST /v1/inbound-webhooks/{inboundWebhookId}/rotate-token` - Rotate an inbound webhook's token (`inbound-webhooks.rotate-token`): [/docs/api/inbound-webhooks/rotate-token.md](/docs/api/inbound-webhooks/rotate-token.md)
- `POST /v1/inbound-webhooks/{inboundWebhookId}/test-mapping` - Test a mapping on a sample body (`inbound-webhooks.test-mapping`): [/docs/api/inbound-webhooks/test-mapping.md](/docs/api/inbound-webhooks/test-mapping.md)
- `GET /v1/inbound-webhooks/{inboundWebhookId}/deliveries` - List an inbound webhook's deliveries (`inbound-webhooks.deliveries`): [/docs/api/inbound-webhooks/deliveries.md](/docs/api/inbound-webhooks/deliveries.md)

## List a campaign's inbound webhooks

`GET /v1/campaigns/{campaignId}/inbound-webhooks` - operationId `inbound-webhooks.list`

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

Returns the inbound webhooks that add contacts to one campaign, ordered by id.

Errors:

- `400 validation_failed`: `limit` or `cursor` is invalid.
- `404 not_found`: the campaign is not in the workspace.

Requires the `integrations` permission.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/inbound-webhooks/GET/v1/campaigns/%7BcampaignId%7D/inbound-webhooks)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `campaignId` | path | integer (int64) | yes | The campaign whose webhooks to list. |
| `limit` | query | integer (int32) | no | Webhooks per page, from 1 to 200. Default 50. |
| `cursor` | query | string | no | The `pagination.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 `InboundWebhook`. Each item has these fields. The response also carries `pagination`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | The inbound webhook's id. |
| `kind` | string | The webhook's kind: `campaign` (each delivery adds a contact to its campaign), `people` (each delivery creates or updates a person), `website` (your website's rb2b, Vector, Snitcher or Warmly webhook, set up through `PATCH /v1/website`, where each delivery records a website visit), `workflow` (each delivery starts a workflow run) or `signal` (each delivery records an intent signal on an account). |
| `campaignId` | integer (int64) | The campaign a `campaign` webhook adds contacts to. Omitted for the other kinds. |
| `name` | string | The webhook's name, from 1 to 120 characters. |
| `url` | string | The URL the sending tool posts JSON to. It holds a secret token, so share it only with that tool. |
| `samplePayloadJson` | string | An example body, kept to help build and test the mapping. Null when none was saved. |
| `mapping` | array of WebhookAssignment | The rules that turn a delivery's JSON into Kenso fields, one entry per field. |
| `status` | string | The webhook's status: `active`, or `paused` when Kenso refuses deliveries to it. |
| `lastReceivedAt` | string (date-time) | When the webhook last received a delivery, in UTC. Null before the first one. |
| `acceptedCount` | integer (int64) | How many deliveries Kenso accepted. |
| `rejectedCount` | integer (int64) | How many deliveries Kenso rejected. |
| `preset` | string | A `people` webhook's preset, when it was created from one, or a `website` webhook's provider. |
| `app` | string | A `people` webhook's sending app: `zapier`, `make` or `n8n`. Omitted when none. |
| `defaultOwnerMemberId` | integer (int64) | The member who owns the people a `people` webhook creates. Omitted: the workspace's intake settings decide. |
| `createAccounts` | boolean | A `people` webhook's account choice: `false` never creates the person's account. Omitted: the workspace's intake settings decide. |
| `peopleCreated` | integer (int64) | How many people a `people` webhook created. Omitted for the other kinds. |
| `peopleUpdated` | integer (int64) | How many existing people a `people` webhook matched and updated. Omitted for the other kinds. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/campaigns/812/inbound-webhooks?limit=50" \
  -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": [
    {
      "id": 812,
      "kind": "string",
      "campaignId": 812,
      "name": "string",
      "url": "https://example.com",
      "samplePayloadJson": "string",
      "mapping": [
        {
          "target": "first_name",
          "variableName": "string",
          "useAsAiContext": true,
          "fallback": true,
          "source": {
            "kind": "path",
            "path": "data.contact.email",
            "value": "string",
            "labelPath": "field.title",
            "valuePath": "string",
            "label": "Email",
            "labelsPath": "string",
            "idPath": "string",
            "index": 1
          }
        }
      ],
      "status": "active",
      "lastReceivedAt": "2026-09-23T15:02:11Z",
      "acceptedCount": 1,
      "rejectedCount": 1,
      "preset": "string",
      "app": "zapier",
      "defaultOwnerMemberId": 812,
      "createAccounts": true,
      "peopleCreated": 1,
      "peopleUpdated": 1
    }
  ],
  "pagination": {
    "nextCursor": "eyJpZCI6ODE1fQ",
    "hasMore": true,
    "total": 1,
    "totalCount": 1,
    "isTotalCapped": true
  }
}
```

## Create a campaign inbound webhook

`POST /v1/campaigns/{campaignId}/inbound-webhooks` - operationId `inbound-webhooks.create`

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

Creates a webhook whose deliveries add contacts to this campaign. The response has the webhook's `url`, which
holds its secret token, and a `Location` header.

`name` is required, from 1 to 120 characters. Send a `mapping`, or a `preset` that fills the
mapping: `hubspot_forms`, `typeform`, `webflow`, `tally`, `rb2b`, `vector`,
`generic`, `zapier`, `make` or `n8n`. A `mapping` you send wins over the preset's.
`samplePayloadJson` is an example body of at most 64 KB. `app`, `defaultOwnerMemberId` and
`createAccounts` belong to people webhooks, and `kind` can only be `campaign` here.

Errors:

- `400 validation_failed`: `name` is missing or too long, the preset is unknown, the mapping is
invalid, the sample is too large, `kind` is not `campaign`, or the body has a people webhook field.
- `404 not_found`: the campaign is not in the workspace.

Requires the `integrations` permission.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/inbound-webhooks/POST/v1/campaigns/%7BcampaignId%7D/inbound-webhooks)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `campaignId` | path | integer (int64) | yes | The campaign the webhook adds contacts to. |
| `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`. |

### Request body

`application/json`, optional.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | yes | Required. The webhook's name, from 1 to 120 characters. |
| `samplePayloadJson` | string | no | An example body from the sending tool, at most 64 KB, kept to help build and test the mapping. |
| `mapping` | array of WebhookAssignment | no | The rules that turn a delivery's JSON into Kenso fields, at most 60. Omitted: the preset's mapping. |
| `preset` | string | no | A ready-made mapping for a known tool: `hubspot_forms`, `typeform`, `webflow`, `tally`, `rb2b`, `vector`, `generic`, `zapier`, `make` or `n8n`. Used when `mapping` is empty. |
| `kind` | string | no | The webhook's kind, `campaign` or `people`. Optional, because the route decides it: `campaign` under a campaign and `people` at the workspace level. A different value is refused with `400`. |
| `app` | string | no | A `people` webhook only: the sending app, `zapier`, `make` or `n8n`. The `zapier`, `make` and `n8n` presets set it. |
| `defaultOwnerMemberId` | integer (int64) | no | A `people` webhook only: the member who owns the people it creates. Omitted: the workspace's intake settings decide. |
| `createAccounts` | boolean | no | A `people` webhook only: `false` never creates an account for the person's company. `true` or omitted: the workspace's intake settings decide. |

### Response 201

`data` is a `InboundWebhook`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | The inbound webhook's id. |
| `kind` | string | The webhook's kind: `campaign` (each delivery adds a contact to its campaign), `people` (each delivery creates or updates a person), `website` (your website's rb2b, Vector, Snitcher or Warmly webhook, set up through `PATCH /v1/website`, where each delivery records a website visit), `workflow` (each delivery starts a workflow run) or `signal` (each delivery records an intent signal on an account). |
| `campaignId` | integer (int64) | The campaign a `campaign` webhook adds contacts to. Omitted for the other kinds. |
| `name` | string | The webhook's name, from 1 to 120 characters. |
| `url` | string | The URL the sending tool posts JSON to. It holds a secret token, so share it only with that tool. |
| `samplePayloadJson` | string | An example body, kept to help build and test the mapping. Null when none was saved. |
| `mapping` | array of WebhookAssignment | The rules that turn a delivery's JSON into Kenso fields, one entry per field. |
| `status` | string | The webhook's status: `active`, or `paused` when Kenso refuses deliveries to it. |
| `lastReceivedAt` | string (date-time) | When the webhook last received a delivery, in UTC. Null before the first one. |
| `acceptedCount` | integer (int64) | How many deliveries Kenso accepted. |
| `rejectedCount` | integer (int64) | How many deliveries Kenso rejected. |
| `preset` | string | A `people` webhook's preset, when it was created from one, or a `website` webhook's provider. |
| `app` | string | A `people` webhook's sending app: `zapier`, `make` or `n8n`. Omitted when none. |
| `defaultOwnerMemberId` | integer (int64) | The member who owns the people a `people` webhook creates. Omitted: the workspace's intake settings decide. |
| `createAccounts` | boolean | A `people` webhook's account choice: `false` never creates the person's account. Omitted: the workspace's intake settings decide. |
| `peopleCreated` | integer (int64) | How many people a `people` webhook created. Omitted for the other kinds. |
| `peopleUpdated` | integer (int64) | How many existing people a `people` webhook matched and updated. Omitted for the other kinds. |

### Request

```bash
curl -X POST "https://api.ken.so/v1/campaigns/812/inbound-webhooks" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "samplePayloadJson": "string",
  "mapping": [
    {
      "target": "first_name",
      "variableName": "string",
      "useAsAiContext": true,
      "fallback": true,
      "source": {
        "kind": "path",
        "path": "data.contact.email",
        "value": "string",
        "labelPath": "field.title",
        "valuePath": "string",
        "label": "Email",
        "labelsPath": "string",
        "idPath": "string",
        "index": 1
      }
    }
  ],
  "preset": "hubspot_forms",
  "kind": "string",
  "app": "string",
  "defaultOwnerMemberId": 812,
  "createAccounts": true
}'
```

### Example response

```json
{
  "success": true,
  "data": {
    "id": 812,
    "kind": "string",
    "campaignId": 812,
    "name": "string",
    "url": "https://example.com",
    "samplePayloadJson": "string",
    "mapping": [
      {
        "target": "first_name",
        "variableName": "string",
        "useAsAiContext": true,
        "fallback": true,
        "source": {
          "kind": "path",
          "path": "data.contact.email",
          "value": "string",
          "labelPath": "field.title",
          "valuePath": "string",
          "label": "Email",
          "labelsPath": "string",
          "idPath": "string",
          "index": 1
        }
      }
    ],
    "status": "active",
    "lastReceivedAt": "2026-09-23T15:02:11Z",
    "acceptedCount": 1,
    "rejectedCount": 1,
    "preset": "string",
    "app": "zapier",
    "defaultOwnerMemberId": 812,
    "createAccounts": true,
    "peopleCreated": 1,
    "peopleUpdated": 1
  }
}
```

## Get an inbound webhook

`GET /v1/inbound-webhooks/{inboundWebhookId}` - operationId `inbound-webhooks.get`

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

Returns one inbound webhook of any kind, with its URL, mapping, status and delivery counts.

Errors:

- `404 not_found`: the workspace has no inbound webhook with this id.

Requires the `integrations` permission.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/inbound-webhooks/GET/v1/inbound-webhooks/%7BinboundWebhookId%7D)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `inboundWebhookId` | path | integer (int64) | yes | The inbound webhook's id. |
| `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 `InboundWebhook`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | The inbound webhook's id. |
| `kind` | string | The webhook's kind: `campaign` (each delivery adds a contact to its campaign), `people` (each delivery creates or updates a person), `website` (your website's rb2b, Vector, Snitcher or Warmly webhook, set up through `PATCH /v1/website`, where each delivery records a website visit), `workflow` (each delivery starts a workflow run) or `signal` (each delivery records an intent signal on an account). |
| `campaignId` | integer (int64) | The campaign a `campaign` webhook adds contacts to. Omitted for the other kinds. |
| `name` | string | The webhook's name, from 1 to 120 characters. |
| `url` | string | The URL the sending tool posts JSON to. It holds a secret token, so share it only with that tool. |
| `samplePayloadJson` | string | An example body, kept to help build and test the mapping. Null when none was saved. |
| `mapping` | array of WebhookAssignment | The rules that turn a delivery's JSON into Kenso fields, one entry per field. |
| `status` | string | The webhook's status: `active`, or `paused` when Kenso refuses deliveries to it. |
| `lastReceivedAt` | string (date-time) | When the webhook last received a delivery, in UTC. Null before the first one. |
| `acceptedCount` | integer (int64) | How many deliveries Kenso accepted. |
| `rejectedCount` | integer (int64) | How many deliveries Kenso rejected. |
| `preset` | string | A `people` webhook's preset, when it was created from one, or a `website` webhook's provider. |
| `app` | string | A `people` webhook's sending app: `zapier`, `make` or `n8n`. Omitted when none. |
| `defaultOwnerMemberId` | integer (int64) | The member who owns the people a `people` webhook creates. Omitted: the workspace's intake settings decide. |
| `createAccounts` | boolean | A `people` webhook's account choice: `false` never creates the person's account. Omitted: the workspace's intake settings decide. |
| `peopleCreated` | integer (int64) | How many people a `people` webhook created. Omitted for the other kinds. |
| `peopleUpdated` | integer (int64) | How many existing people a `people` webhook matched and updated. Omitted for the other kinds. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/inbound-webhooks/812" \
  -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": {
    "id": 812,
    "kind": "string",
    "campaignId": 812,
    "name": "string",
    "url": "https://example.com",
    "samplePayloadJson": "string",
    "mapping": [
      {
        "target": "first_name",
        "variableName": "string",
        "useAsAiContext": true,
        "fallback": true,
        "source": {
          "kind": "path",
          "path": "data.contact.email",
          "value": "string",
          "labelPath": "field.title",
          "valuePath": "string",
          "label": "Email",
          "labelsPath": "string",
          "idPath": "string",
          "index": 1
        }
      }
    ],
    "status": "active",
    "lastReceivedAt": "2026-09-23T15:02:11Z",
    "acceptedCount": 1,
    "rejectedCount": 1,
    "preset": "string",
    "app": "zapier",
    "defaultOwnerMemberId": 812,
    "createAccounts": true,
    "peopleCreated": 1,
    "peopleUpdated": 1
  }
}
```

## Update an inbound webhook

`PATCH /v1/inbound-webhooks/{inboundWebhookId}` - operationId `inbound-webhooks.update`

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

Changes the fields you send. Omitted fields keep their values, and the URL does not change.

Every kind takes `name`, `samplePayloadJson`, `mapping` and `status`. `status` is
`active` or `paused`, and Kenso refuses deliveries to a paused webhook. A people webhook also takes
`app` (`zapier`, `make` or `n8n`, or null to clear it), `defaultOwnerMemberId` (a
member of the workspace, or null to clear it) and `createAccounts`, and keeps its preset and people
counts. A workflow webhook also takes `createPerson`. Any other kind refuses these fields.

The `mapping` must map what the webhook's kind needs: a campaign webhook `first_name`,
`last_name` and `company_domain` or `company_name`; a people webhook `email`,
`profile_url`, or a name with `company_domain`; a website webhook `company_domain` or
`email`. A workflow or signal webhook's mapping needs no field and may be empty: a workflow run gets
whatever the mapping finds, and a signal webhook reads deliveries with its vendor's reader, not its mapping.
Publishing a workflow replaces its webhook's mapping with the one on its webhook trigger.

A website webhook follows the visitor-ID provider set for your website in Settings, Integrations. The next
`PATCH /v1/website` that names a provider resumes it and resets its mapping to that provider's preset. Set
the provider to `none` to stop it.

Errors:

- `400 validation_failed`: a field has the wrong type or value, the mapping is invalid, the sample is
larger than 64 KB, or the field does not fit the webhook's kind. `error.details[0].field` names the field,
and `error.details[0].code` is `invalid_member` for an owner outside the workspace.
- `404 not_found`: the workspace has no inbound webhook with this id.

Requires the `integrations` permission.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/inbound-webhooks/PATCH/v1/inbound-webhooks/%7BinboundWebhookId%7D)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `inboundWebhookId` | path | integer (int64) | yes | The inbound webhook's id. |
| `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`. |

### Request body

`application/json`, optional.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | no | A new name, from 1 to 120 characters. |
| `samplePayloadJson` | string | no | A new example body, at most 64 KB. |
| `mapping` | array of WebhookAssignment | no | A new mapping that replaces the current one, at most 60 entries. |
| `status` | string | no | The webhook's status: `active` or `paused`. Kenso refuses deliveries to a paused webhook. |
| `app` | string | no | A `people` webhook only: `zapier`, `make` or `n8n`, or `null` to clear it. |
| `defaultOwnerMemberId` | integer (int64) | no | A `people` webhook only: a member of the workspace who owns the people it creates, or `null` to clear it. |
| `createAccounts` | boolean | no | A `people` webhook only: `false` never creates an account for the person's company. `true` lets the workspace's intake settings decide. |
| `createPerson` | boolean | no | A `workflow` webhook only: whether each delivery also creates or updates a person when the workflow's webhook trigger does not say. |

### Response 200

`data` is a `InboundWebhook`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | The inbound webhook's id. |
| `kind` | string | The webhook's kind: `campaign` (each delivery adds a contact to its campaign), `people` (each delivery creates or updates a person), `website` (your website's rb2b, Vector, Snitcher or Warmly webhook, set up through `PATCH /v1/website`, where each delivery records a website visit), `workflow` (each delivery starts a workflow run) or `signal` (each delivery records an intent signal on an account). |
| `campaignId` | integer (int64) | The campaign a `campaign` webhook adds contacts to. Omitted for the other kinds. |
| `name` | string | The webhook's name, from 1 to 120 characters. |
| `url` | string | The URL the sending tool posts JSON to. It holds a secret token, so share it only with that tool. |
| `samplePayloadJson` | string | An example body, kept to help build and test the mapping. Null when none was saved. |
| `mapping` | array of WebhookAssignment | The rules that turn a delivery's JSON into Kenso fields, one entry per field. |
| `status` | string | The webhook's status: `active`, or `paused` when Kenso refuses deliveries to it. |
| `lastReceivedAt` | string (date-time) | When the webhook last received a delivery, in UTC. Null before the first one. |
| `acceptedCount` | integer (int64) | How many deliveries Kenso accepted. |
| `rejectedCount` | integer (int64) | How many deliveries Kenso rejected. |
| `preset` | string | A `people` webhook's preset, when it was created from one, or a `website` webhook's provider. |
| `app` | string | A `people` webhook's sending app: `zapier`, `make` or `n8n`. Omitted when none. |
| `defaultOwnerMemberId` | integer (int64) | The member who owns the people a `people` webhook creates. Omitted: the workspace's intake settings decide. |
| `createAccounts` | boolean | A `people` webhook's account choice: `false` never creates the person's account. Omitted: the workspace's intake settings decide. |
| `peopleCreated` | integer (int64) | How many people a `people` webhook created. Omitted for the other kinds. |
| `peopleUpdated` | integer (int64) | How many existing people a `people` webhook matched and updated. Omitted for the other kinds. |

### Request

```bash
curl -X PATCH "https://api.ken.so/v1/inbound-webhooks/812" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "samplePayloadJson": "string",
  "mapping": [
    {
      "target": "first_name",
      "variableName": "string",
      "useAsAiContext": true,
      "fallback": true,
      "source": {
        "kind": "path",
        "path": "data.contact.email",
        "value": "string",
        "labelPath": "field.title",
        "valuePath": "string",
        "label": "Email",
        "labelsPath": "string",
        "idPath": "string",
        "index": 1
      }
    }
  ],
  "status": "active",
  "app": "zapier",
  "defaultOwnerMemberId": 812,
  "createAccounts": true,
  "createPerson": true
}'
```

### Example response

```json
{
  "success": true,
  "data": {
    "id": 812,
    "kind": "string",
    "campaignId": 812,
    "name": "string",
    "url": "https://example.com",
    "samplePayloadJson": "string",
    "mapping": [
      {
        "target": "first_name",
        "variableName": "string",
        "useAsAiContext": true,
        "fallback": true,
        "source": {
          "kind": "path",
          "path": "data.contact.email",
          "value": "string",
          "labelPath": "field.title",
          "valuePath": "string",
          "label": "Email",
          "labelsPath": "string",
          "idPath": "string",
          "index": 1
        }
      }
    ],
    "status": "active",
    "lastReceivedAt": "2026-09-23T15:02:11Z",
    "acceptedCount": 1,
    "rejectedCount": 1,
    "preset": "string",
    "app": "zapier",
    "defaultOwnerMemberId": 812,
    "createAccounts": true,
    "peopleCreated": 1,
    "peopleUpdated": 1
  }
}
```

## Delete an inbound webhook

`DELETE /v1/inbound-webhooks/{inboundWebhookId}` - operationId `inbound-webhooks.delete`

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

Deletes the inbound webhook. Kenso stops accepting deliveries to its URL. Contacts and people it already
created stay.

Errors:

- `404 not_found`: the workspace has no inbound webhook with this id.

Requires the `integrations` permission.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/inbound-webhooks/DELETE/v1/inbound-webhooks/%7BinboundWebhookId%7D)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `inboundWebhookId` | path | integer (int64) | yes | The inbound webhook's id. |
| `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 204

### Request

```bash
curl -X DELETE "https://api.ken.so/v1/inbound-webhooks/812" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"
```

### Example response

```http
HTTP/1.1 204 No Content
```

## List people webhooks

`GET /v1/inbound-webhooks` - operationId `inbound-webhooks.list-people-sources`

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

Returns the workspace's people webhooks, ordered by id. Each delivery to a people webhook creates or updates a
person, with the source `form` for the form presets, `visitor` for `rb2b` and `vector`, and
`webhook` otherwise. A campaign's webhooks are listed under the campaign.

Errors:

- `400 validation_failed`: `limit` or `cursor` is invalid.

Requires the `integrations` permission.

Needs the `accounts` feature on your workspace. Until it is on, calls answer 404. Needs the `lead_intake` feature on your workspace. Until it is on, calls answer 404.

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

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `limit` | query | integer (int32) | no | Webhooks per page, from 1 to 200. Default 50. |
| `cursor` | query | string | no | The `pagination.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 `InboundWebhook`. Each item has these fields. The response also carries `pagination`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | The inbound webhook's id. |
| `kind` | string | The webhook's kind: `campaign` (each delivery adds a contact to its campaign), `people` (each delivery creates or updates a person), `website` (your website's rb2b, Vector, Snitcher or Warmly webhook, set up through `PATCH /v1/website`, where each delivery records a website visit), `workflow` (each delivery starts a workflow run) or `signal` (each delivery records an intent signal on an account). |
| `campaignId` | integer (int64) | The campaign a `campaign` webhook adds contacts to. Omitted for the other kinds. |
| `name` | string | The webhook's name, from 1 to 120 characters. |
| `url` | string | The URL the sending tool posts JSON to. It holds a secret token, so share it only with that tool. |
| `samplePayloadJson` | string | An example body, kept to help build and test the mapping. Null when none was saved. |
| `mapping` | array of WebhookAssignment | The rules that turn a delivery's JSON into Kenso fields, one entry per field. |
| `status` | string | The webhook's status: `active`, or `paused` when Kenso refuses deliveries to it. |
| `lastReceivedAt` | string (date-time) | When the webhook last received a delivery, in UTC. Null before the first one. |
| `acceptedCount` | integer (int64) | How many deliveries Kenso accepted. |
| `rejectedCount` | integer (int64) | How many deliveries Kenso rejected. |
| `preset` | string | A `people` webhook's preset, when it was created from one, or a `website` webhook's provider. |
| `app` | string | A `people` webhook's sending app: `zapier`, `make` or `n8n`. Omitted when none. |
| `defaultOwnerMemberId` | integer (int64) | The member who owns the people a `people` webhook creates. Omitted: the workspace's intake settings decide. |
| `createAccounts` | boolean | A `people` webhook's account choice: `false` never creates the person's account. Omitted: the workspace's intake settings decide. |
| `peopleCreated` | integer (int64) | How many people a `people` webhook created. Omitted for the other kinds. |
| `peopleUpdated` | integer (int64) | How many existing people a `people` webhook matched and updated. Omitted for the other kinds. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/inbound-webhooks?limit=50" \
  -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": [
    {
      "id": 812,
      "kind": "string",
      "campaignId": 812,
      "name": "string",
      "url": "https://example.com",
      "samplePayloadJson": "string",
      "mapping": [
        {
          "target": "first_name",
          "variableName": "string",
          "useAsAiContext": true,
          "fallback": true,
          "source": {
            "kind": "path",
            "path": "data.contact.email",
            "value": "string",
            "labelPath": "field.title",
            "valuePath": "string",
            "label": "Email",
            "labelsPath": "string",
            "idPath": "string",
            "index": 1
          }
        }
      ],
      "status": "active",
      "lastReceivedAt": "2026-09-23T15:02:11Z",
      "acceptedCount": 1,
      "rejectedCount": 1,
      "preset": "string",
      "app": "zapier",
      "defaultOwnerMemberId": 812,
      "createAccounts": true,
      "peopleCreated": 1,
      "peopleUpdated": 1
    }
  ],
  "pagination": {
    "nextCursor": "eyJpZCI6ODE1fQ",
    "hasMore": true,
    "total": 1,
    "totalCount": 1,
    "isTotalCapped": true
  }
}
```

## Create a people webhook

`POST /v1/inbound-webhooks` - operationId `inbound-webhooks.create-people-source`

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

Creates a workspace webhook whose deliveries create or update a person. The response has the webhook's
`url`, which holds its secret token, and a `Location` header.

`name` is required, from 1 to 120 characters. Send a `preset`, an `app` or a `mapping`.
The presets are `hubspot_forms`, `typeform`, `webflow`, `tally`, `rb2b`,
`vector`, `generic`, `zapier`, `make` and `n8n`. The `zapier`, `make` and
`n8n` presets read the generic flat keys and set `app`, and an `app` with no preset or mapping
reads them too. A `mapping` you send wins over the preset's, and must map an email, a
`profile_url`, or a name together with a `company_domain`.

`defaultOwnerMemberId` must be a member of the workspace. `createAccounts: false` never creates the
person's account.

Errors:

- `400 validation_failed`: `name` is missing or too long, the mapping is missing or invalid, the
sample is too large, `kind` is not `people`, `app` is unknown or differs from the preset's
app, or `defaultOwnerMemberId` is not a member. `error.details[0].code` is `unknown_preset`
for an unknown preset and `invalid_member` for an owner outside the workspace.

Requires the `integrations` permission.

Needs the `accounts` feature on your workspace. Until it is on, calls answer 404. Needs the `lead_intake` feature on your workspace. Until it is on, calls answer 404.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/inbound-webhooks/POST/v1/inbound-webhooks)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `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`. |

### Request body

`application/json`, optional.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | yes | Required. The webhook's name, from 1 to 120 characters. |
| `samplePayloadJson` | string | no | An example body from the sending tool, at most 64 KB, kept to help build and test the mapping. |
| `mapping` | array of WebhookAssignment | no | The rules that turn a delivery's JSON into Kenso fields, at most 60. Omitted: the preset's mapping. |
| `preset` | string | no | A ready-made mapping for a known tool: `hubspot_forms`, `typeform`, `webflow`, `tally`, `rb2b`, `vector`, `generic`, `zapier`, `make` or `n8n`. Used when `mapping` is empty. |
| `kind` | string | no | The webhook's kind, `campaign` or `people`. Optional, because the route decides it: `campaign` under a campaign and `people` at the workspace level. A different value is refused with `400`. |
| `app` | string | no | A `people` webhook only: the sending app, `zapier`, `make` or `n8n`. The `zapier`, `make` and `n8n` presets set it. |
| `defaultOwnerMemberId` | integer (int64) | no | A `people` webhook only: the member who owns the people it creates. Omitted: the workspace's intake settings decide. |
| `createAccounts` | boolean | no | A `people` webhook only: `false` never creates an account for the person's company. `true` or omitted: the workspace's intake settings decide. |

### Response 201

`data` is a `InboundWebhook`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | The inbound webhook's id. |
| `kind` | string | The webhook's kind: `campaign` (each delivery adds a contact to its campaign), `people` (each delivery creates or updates a person), `website` (your website's rb2b, Vector, Snitcher or Warmly webhook, set up through `PATCH /v1/website`, where each delivery records a website visit), `workflow` (each delivery starts a workflow run) or `signal` (each delivery records an intent signal on an account). |
| `campaignId` | integer (int64) | The campaign a `campaign` webhook adds contacts to. Omitted for the other kinds. |
| `name` | string | The webhook's name, from 1 to 120 characters. |
| `url` | string | The URL the sending tool posts JSON to. It holds a secret token, so share it only with that tool. |
| `samplePayloadJson` | string | An example body, kept to help build and test the mapping. Null when none was saved. |
| `mapping` | array of WebhookAssignment | The rules that turn a delivery's JSON into Kenso fields, one entry per field. |
| `status` | string | The webhook's status: `active`, or `paused` when Kenso refuses deliveries to it. |
| `lastReceivedAt` | string (date-time) | When the webhook last received a delivery, in UTC. Null before the first one. |
| `acceptedCount` | integer (int64) | How many deliveries Kenso accepted. |
| `rejectedCount` | integer (int64) | How many deliveries Kenso rejected. |
| `preset` | string | A `people` webhook's preset, when it was created from one, or a `website` webhook's provider. |
| `app` | string | A `people` webhook's sending app: `zapier`, `make` or `n8n`. Omitted when none. |
| `defaultOwnerMemberId` | integer (int64) | The member who owns the people a `people` webhook creates. Omitted: the workspace's intake settings decide. |
| `createAccounts` | boolean | A `people` webhook's account choice: `false` never creates the person's account. Omitted: the workspace's intake settings decide. |
| `peopleCreated` | integer (int64) | How many people a `people` webhook created. Omitted for the other kinds. |
| `peopleUpdated` | integer (int64) | How many existing people a `people` webhook matched and updated. Omitted for the other kinds. |

### Request

```bash
curl -X POST "https://api.ken.so/v1/inbound-webhooks" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "samplePayloadJson": "string",
  "mapping": [
    {
      "target": "first_name",
      "variableName": "string",
      "useAsAiContext": true,
      "fallback": true,
      "source": {
        "kind": "path",
        "path": "data.contact.email",
        "value": "string",
        "labelPath": "field.title",
        "valuePath": "string",
        "label": "Email",
        "labelsPath": "string",
        "idPath": "string",
        "index": 1
      }
    }
  ],
  "preset": "hubspot_forms",
  "kind": "string",
  "app": "string",
  "defaultOwnerMemberId": 812,
  "createAccounts": true
}'
```

### Example response

```json
{
  "success": true,
  "data": {
    "id": 812,
    "kind": "string",
    "campaignId": 812,
    "name": "string",
    "url": "https://example.com",
    "samplePayloadJson": "string",
    "mapping": [
      {
        "target": "first_name",
        "variableName": "string",
        "useAsAiContext": true,
        "fallback": true,
        "source": {
          "kind": "path",
          "path": "data.contact.email",
          "value": "string",
          "labelPath": "field.title",
          "valuePath": "string",
          "label": "Email",
          "labelsPath": "string",
          "idPath": "string",
          "index": 1
        }
      }
    ],
    "status": "active",
    "lastReceivedAt": "2026-09-23T15:02:11Z",
    "acceptedCount": 1,
    "rejectedCount": 1,
    "preset": "string",
    "app": "zapier",
    "defaultOwnerMemberId": 812,
    "createAccounts": true,
    "peopleCreated": 1,
    "peopleUpdated": 1
  }
}
```

## Rotate an inbound webhook's token

`POST /v1/inbound-webhooks/{inboundWebhookId}/rotate-token` - operationId `inbound-webhooks.rotate-token`

| Permission | Rate limit |
| --- | --- |
| The `integrations` permission | 200 requests a minute per API key |

Gives the webhook a new secret token, so its `url` changes. The old URL stops working at once, so update
the sending tool with the new `url` from the response. Use it when the URL leaked.

Errors:

- `404 not_found`: the workspace has no inbound webhook with this id.

Requires the `integrations` permission.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/inbound-webhooks/POST/v1/inbound-webhooks/%7BinboundWebhookId%7D/rotate-token)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `inboundWebhookId` | path | integer (int64) | yes | The inbound webhook's id. |
| `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 `InboundWebhook`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | The inbound webhook's id. |
| `kind` | string | The webhook's kind: `campaign` (each delivery adds a contact to its campaign), `people` (each delivery creates or updates a person), `website` (your website's rb2b, Vector, Snitcher or Warmly webhook, set up through `PATCH /v1/website`, where each delivery records a website visit), `workflow` (each delivery starts a workflow run) or `signal` (each delivery records an intent signal on an account). |
| `campaignId` | integer (int64) | The campaign a `campaign` webhook adds contacts to. Omitted for the other kinds. |
| `name` | string | The webhook's name, from 1 to 120 characters. |
| `url` | string | The URL the sending tool posts JSON to. It holds a secret token, so share it only with that tool. |
| `samplePayloadJson` | string | An example body, kept to help build and test the mapping. Null when none was saved. |
| `mapping` | array of WebhookAssignment | The rules that turn a delivery's JSON into Kenso fields, one entry per field. |
| `status` | string | The webhook's status: `active`, or `paused` when Kenso refuses deliveries to it. |
| `lastReceivedAt` | string (date-time) | When the webhook last received a delivery, in UTC. Null before the first one. |
| `acceptedCount` | integer (int64) | How many deliveries Kenso accepted. |
| `rejectedCount` | integer (int64) | How many deliveries Kenso rejected. |
| `preset` | string | A `people` webhook's preset, when it was created from one, or a `website` webhook's provider. |
| `app` | string | A `people` webhook's sending app: `zapier`, `make` or `n8n`. Omitted when none. |
| `defaultOwnerMemberId` | integer (int64) | The member who owns the people a `people` webhook creates. Omitted: the workspace's intake settings decide. |
| `createAccounts` | boolean | A `people` webhook's account choice: `false` never creates the person's account. Omitted: the workspace's intake settings decide. |
| `peopleCreated` | integer (int64) | How many people a `people` webhook created. Omitted for the other kinds. |
| `peopleUpdated` | integer (int64) | How many existing people a `people` webhook matched and updated. Omitted for the other kinds. |

### Request

```bash
curl -X POST "https://api.ken.so/v1/inbound-webhooks/812/rotate-token" \
  -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": {
    "id": 812,
    "kind": "string",
    "campaignId": 812,
    "name": "string",
    "url": "https://example.com",
    "samplePayloadJson": "string",
    "mapping": [
      {
        "target": "first_name",
        "variableName": "string",
        "useAsAiContext": true,
        "fallback": true,
        "source": {
          "kind": "path",
          "path": "data.contact.email",
          "value": "string",
          "labelPath": "field.title",
          "valuePath": "string",
          "label": "Email",
          "labelsPath": "string",
          "idPath": "string",
          "index": 1
        }
      }
    ],
    "status": "active",
    "lastReceivedAt": "2026-09-23T15:02:11Z",
    "acceptedCount": 1,
    "rejectedCount": 1,
    "preset": "string",
    "app": "zapier",
    "defaultOwnerMemberId": 812,
    "createAccounts": true,
    "peopleCreated": 1,
    "peopleUpdated": 1
  }
}
```

## Test a mapping on a sample body

`POST /v1/inbound-webhooks/{inboundWebhookId}/test-mapping` - operationId `inbound-webhooks.test-mapping`

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

Runs a mapping on a sample body and returns the result, without creating a contact or person and without
saving the mapping. Use it to check a mapping before you save it with
`PATCH /v1/inbound-webhooks/{inboundWebhookId}`.

Send `samplePayloadJson` and `mapping`. Kenso checks the mapping with the rules of this webhook's
kind. The response lists the fields and custom variables the mapping filled, the paths it could not find, and
whether Kenso would accept the delivery.

On every kind, each mapping row needs a known target and a payload path or constant. Each kind also has the rule
a real delivery meets:

- `campaign`: `first_name`, `last_name`, and `company_domain` or `company_name`.
- `people`: `email`, `profile_url`, or a name with `company_domain`.
- `website`: the mapping maps `company_domain` or `email`, and the sample fills `email`,
`profile_url` or `company_domain`.
- `workflow`: no required field, and the mapping may be empty. Every delivery starts a run with the fields
the mapping finds.
- `signal`: the mapping is not used. The sample must be a payload the webhook's vendor sends.

Errors:

- `400 validation_failed`: `samplePayloadJson` is missing, larger than 64 KB or not valid JSON.
- `404 not_found`: the workspace has no inbound webhook with this id.

Requires the `integrations` permission.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/inbound-webhooks/POST/v1/inbound-webhooks/%7BinboundWebhookId%7D/test-mapping)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `inboundWebhookId` | path | integer (int64) | yes | The inbound webhook's id. |
| `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`. |

### Request body

`application/json`, optional.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `samplePayloadJson` | string | yes | Required. An example body from the sending tool, as a JSON string of at most 64 KB. |
| `mapping` | array of WebhookAssignment | no | The mapping to run on the sample. |

### Response 200

`data` is a `InboundWebhookMappingTest`.

| Field | Type | Description |
| --- | --- | --- |
| `resolvedFields` | map of string | The Kenso fields the mapping filled, by field name, with the values it read. |
| `resolvedCustomVariables` | map of string | The custom variables the mapping filled, by variable name, with the values it read. |
| `unresolvedPaths` | array of string | The mapping's paths that found nothing in the sample body. |
| `wouldBeAccepted` | boolean | True when Kenso would accept a delivery with this body. |
| `rejectionReason` | string | Why Kenso would reject the delivery. Null when it would accept it. |

### Request

```bash
curl -X POST "https://api.ken.so/v1/inbound-webhooks/812/test-mapping" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "samplePayloadJson": "string",
  "mapping": [
    {
      "target": "first_name",
      "variableName": "string",
      "useAsAiContext": true,
      "fallback": true,
      "source": {
        "kind": "path",
        "path": "data.contact.email",
        "value": "string",
        "labelPath": "field.title",
        "valuePath": "string",
        "label": "Email",
        "labelsPath": "string",
        "idPath": "string",
        "index": 1
      }
    }
  ]
}'
```

### Example response

```json
{
  "success": true,
  "data": {
    "resolvedFields": {
      "key": "string"
    },
    "resolvedCustomVariables": {
      "key": "string"
    },
    "unresolvedPaths": [
      "string"
    ],
    "wouldBeAccepted": true,
    "rejectionReason": "string"
  }
}
```

## List an inbound webhook's deliveries

`GET /v1/inbound-webhooks/{inboundWebhookId}/deliveries` - operationId `inbound-webhooks.deliveries`

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

Returns the most recent deliveries to the webhook, with what Kenso did with each one and why. Use it to find
out why a sending tool's data did not arrive.

`limit` is from 1 to 100, default 100. This list has one page and no cursor.

Errors:

- `400 validation_failed`: `limit` is out of range.
- `404 not_found`: the workspace has no inbound webhook with this id.

Requires the `integrations` permission.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/inbound-webhooks/GET/v1/inbound-webhooks/%7BinboundWebhookId%7D/deliveries)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `inboundWebhookId` | path | integer (int64) | yes | The inbound webhook's id. |
| `limit` | query | integer (int32) | no | How many recent deliveries to return, from 1 to 100. Default 100. |
| `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 `InboundWebhookDelivery`. Each item has these fields. The response also carries `pagination`.

| Field | Type | Description |
| --- | --- | --- |
| `receivedAt` | string (date-time) | When Kenso received the delivery, in UTC. |
| `outcome` | string | What Kenso did with the delivery, such as `accepted`, `duplicate`, `rejected` or `rate_limited`. |
| `reason` | string | Why Kenso rejected the delivery. Null when it accepted it. |
| `httpStatus` | integer (int32) | The HTTP status Kenso answered the sending tool with. |
| `body` | string | The body the tool sent, cut at 16 KB. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/inbound-webhooks/812/deliveries?limit=100" \
  -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": [
    {
      "receivedAt": "2026-09-23T15:02:11Z",
      "outcome": "accepted",
      "reason": "string",
      "httpStatus": 1,
      "body": "string"
    }
  ],
  "pagination": {
    "nextCursor": "eyJpZCI6ODE1fQ",
    "hasMore": true,
    "total": 1,
    "totalCount": 1,
    "isTotalCapped": true
  }
}
```

## Types

Each named type the tables above use, nested ones included.

### WebhookAssignment

One mapping entry: which Kenso field to fill and where to read its value.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `target` | string | no | The Kenso field to fill, such as `first_name`, `email`, `title`, `company_name` or `company_domain`, or `custom_variable` to fill a custom variable. The same field names a CSV import takes. |
| `variableName` | string | no | The custom variable's name when `target` is `custom_variable`. Ignored otherwise. |
| `useAsAiContext` | boolean | no | For a custom variable: true lets Ken use its value as context when writing to the contact. Default false. |
| `fallback` | boolean | no | True when this entry only fills a field that an earlier entry left empty, so one field can have a second source. Without it, each field is mapped once. |
| `source` | WebhookAssignmentSource | no | Where to read the value from the incoming JSON. |

### WebhookAssignmentSource

Where a mapping entry reads its value from the incoming JSON.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `kind` | string | no | How to read the value: `path` reads it at `path`, `constant` uses `value` as is, and `label` finds a form answer by its question label. Default `path`. |
| `path` | string | no | A dot and bracket path into the body, such as `data.contact.email` or `answers[0].text`. For kind `label`, the path of the array of answers to search. |
| `value` | string | no | Kind `constant`: the fixed value to use. |
| `labelPath` | string | no | Kind `label`: the path, inside each answer, of the label to compare, such as `field.title`. |
| `valuePath` | string | no | Kind `label`: the path, inside the matching answer, of its value. Separate alternatives with `\|`, such as `email\|text\|choice.label`, and Kenso tries them in order, so one entry reads any answer type. |
| `label` | string | no | Kind `label`: the question label to find, such as `Email`. Kenso ignores case and surrounding spaces. |
| `labelsPath` | string | no | Kind `label`, optional: the path of an array that holds the labels apart from the answers. Kenso finds the label there at `labelPath`, then picks the answer whose `idPath` equals that element's `id`. |
| `idPath` | string | no | Kind `label` with `labelsPath`: the path, inside each answer, of the id that joins it to its label. |
| `index` | integer (int32) | no | Kind `label`, optional: only the answer at this zero-based position can match, and only when no entry without a position matched that answer. An entry with a position never reads an answer another entry already mapped. |

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