> 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: Update an inbound webhook

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

One endpoint of [Inbound webhooks](/docs/api/inbound-webhooks.md). Authentication, workspaces and errors: [/docs.md](/docs.md).

## 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
  }
}
```

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