---
title: "Create a new Webhook record entry"
method: POST
path: "/webhook"
tags: ["webhook"]
---

# Create a new Webhook record entry

`POST /webhook`

Creates a new webhook configuration for receiving real-time event notifications. Webhooks enable integration with external systems by sending HTTP requests when specified events occur.

## Request body

- WebhookPost
  - `webhook_status` 'active' | 'inactive', required — The current status of webhook. Type: enum (string); Allowed values: active, inactive.
  - `org_unit_id` integer, required — Organization unit (group) ID. Integer. Same concept as group_id; used in newer endpoints.
  - `webhook_Name` string, required — Name of the Webhook. Type: string.
  - `description` string — Description of Webhook. Type: string.
  - `webhook_Endpoint` string, required — End Point URl saved with webhook , where response is received. Type: string.
  - `method` 'POST' | 'PUT', required — type of method. Type: enum (string); Allowed values: POST, PUT.
  - `format` 'JSON' | 'XML' | 'XML_NEW' | 'XML_CQM' | 'FORM-URLENCODED', required — type of format. Type: enum (string); Allowed values: JSON, XML, XML_NEW, XML_CQM, FORM-URLENCODED.
  - `include_Data_Append` boolean — This enables user to see Data Append of call in response. Type: boolean.
  - `include_DNI_Logs` boolean — This enables user to see DNI setting of the call flow in response whom with webhook is attached. Type: boolean.
  - `include_Indicator_Scores` boolean — This enables user to see indicator scores of call in response. Type: boolean.
  - `static_Parameter` object[] — Extra parameters required to be displayed in response. Type: array of object.
    - `field_Name` string — Name of static parameter. Type: string.
    - `field_Value` string — Value of static parameter. Type: string.
  - `include_IVR_Keypresses` boolean — This enables user to see ivr keypresses of call in response. Type: boolean.

## Response `200`

Newly created webhook ID and confirmation status

- StandardPostResponse[]
  - `result` string, required — Outcome of the request. String, typically 'success' or 'error'.
  - `data` string, required — Response payload. Shape varies by endpoint.
  - `entry_count` integer, required — The sequential number of the entry in the submitted array. Type: integer (int32).

## Other responses

- `default` — Unexpected error

---

[API](https://skmtc.net/convirza/apis/convirza-apis.md) · [All operations](https://skmtc.net/convirza/apis/convirza-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/convirza/convirza-apis/versions/ccf9bbe34f5a/schema)