---
title: "Update Importer Webhook"
method: PUT
path: "/v1/importer-webhooks/{webhook_key}"
tags: ["Importer Webhooks"]
---

# Update Importer Webhook

`PUT /v1/importer-webhooks/{webhook_key}`

Update fields on an Importer Webhook. All body fields are optional; only provided fields are updated.

## Path parameters

- `webhook_key` string, required

## Request body

- ImporterWebhookUpdateRequest — All fields are optional. Only fields provided in the request body are updated; unspecified fields retain their existing values.
  - `url` string — The URL that the importer will POST to.
  - `type` 'batch' | 'metadata' — The delivery mode for the webhook. `batch` delivers rows in batches; `metadata` delivers only the import metadata.
  - `new_webhook_key` string — Optional new value for `webhook_key`. The path parameter identifies the existing webhook; this field renames it.
  - `auth_type` 'basic' | 'bearer_user_jwt', nullable — The authentication mode for requests to the webhook URL. `basic` requires a `secret_key`. `bearer_user_jwt` attaches the end-user JWT as a bearer token. Omit (`null`) for unauthenticated delivery.
  - `secret_key` string, nullable — The shared secret used for `basic` auth. Cleared automatically if `auth_type` is changed to a non-`basic` value.
  - `batch_size` integer, nullable

## Response `200`

The request has succeeded.

- ImporterWebhookResource
  - `id` integer — The unique identifier of the importer webhook.
  - `webhook_key` string — The org-unique key identifying this webhook.
  - `type` 'batch' | 'metadata' — The delivery mode for the webhook. `batch` delivers rows in batches; `metadata` delivers only the import metadata.
  - `url` string — The URL that the importer will POST to.
  - `auth_type` 'basic' | 'bearer_user_jwt', nullable — The authentication mode for requests to the webhook URL. `basic` requires a `secret_key`. `bearer_user_jwt` attaches the end-user JWT as a bearer token. Omit (`null`) for unauthenticated delivery.
  - `secret_key` string, nullable — The shared secret used for `basic` auth. Only returned to admin and developer API key users.
  - `batch_size` integer, nullable — Optional batch size (number of rows per webhook request) for `batch`-type webhooks.

## Other responses

- `400` — Bad request
- `401` — Unauthorized (missing or invalid API key)
- `403` — Forbidden

---

[API](https://skmtc.net/oneschema/apis/templates.md) · [All operations](https://skmtc.net/oneschema/apis/templates/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/oneschema/templates/revisions/40674aa6d4d9/schema)