---
title: "POST /webhook"
method: POST
path: "/webhook"
tags: ["webhook"]
---

# POST /webhook

`POST /webhook`

## Request

- Base URL: `https://www.weclapp.com/api/nullapi/v2`
- URL: `https://www.weclapp.com/api/nullapi/v2/webhook`
- Auth: API key in header `AuthenticationToken`
- TypeScript: <https://skmtc.dev/weclapp/apis/weclapp-api/docs/webhook/post.ts> (a function with typed inputs; its response is checked against the schema)

create a webhook

## Query parameters

- `dryRun` boolean

## Request body

- Webhook
  - `id` string
  - `version` string
  - `atCreate` boolean
  - `atDelete` boolean
  - `atUpdate` boolean
  - `createdDate` integer
  - `deactivatedDate` integer
  - `entityName` string, required
  - `errorMessage` string
  - `lastModifiedDate` integer
  - `requestMethod` 'GET' | 'POST'
  - `url` string, required

## Response `201`

webhook create response

- Webhook
  - `id` string
  - `version` string
  - `atCreate` boolean
  - `atDelete` boolean
  - `atUpdate` boolean
  - `createdDate` integer
  - `deactivatedDate` integer
  - `entityName` string, required
  - `errorMessage` string
  - `lastModifiedDate` integer
  - `requestMethod` 'GET' | 'POST'
  - `url` string, required

## Other responses

- `default`: error response

## Changes

- **2026-11-07** `0e021229755d`: 1 info
  - added the new optional `query` request parameter `dryRun`

[Operation history](https://skmtc.dev/weclapp/apis/weclapp-api/changes/webhook/post.md)

---

[API](https://skmtc.dev/weclapp/apis/weclapp-api.md) - [All operations](https://skmtc.dev/weclapp/apis/weclapp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/weclapp/apis/weclapp-api/revisions/0e021229755d?raw)