---
title: "Create a new webhook"
method: POST
path: "/api/v1/webhooks"
tags: ["Webhooks"]
---

# Create a new webhook

`POST /api/v1/webhooks`

## Request

- Base URL: `https://api.korala.ai`
- URL: `https://api.korala.ai/api/v1/webhooks`
- Auth: one of:
  - API key in header `X-API-Key`
  - `bearer` (a scheme the document does not define)

## Request body

- CreateWebhookDto
  - `url` string, required
  - `events` WebhookEventType[], required
  - `description` string
  - `mode` 'live' | 'test': Which traffic this endpoint receives: live or test documents, sessions and workflows. API credentials pin the mode. Existing subscriptions cannot change mode.

## Response `201`

- WebhookWithSecretDto
  - `id` string, required
  - `url` string, required
  - `events` WebhookEventType[], required
  - `mode` 'live' | 'test', required: Which traffic this endpoint receives: live or test documents, sessions and workflows. API credentials pin the mode. Existing subscriptions cannot change mode.
  - `isActive` boolean, required
  - `description` string
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required
  - `secret` string, required: Secret for HMAC signature verification (only shown once)

---

[API](https://skmtc.dev/korala/apis/korala-public-api.md) · [All operations](https://skmtc.dev/korala/apis/korala-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/korala/apis/korala-public-api/revisions/5c4d7810c507?raw)