---
title: "Add Webhook"
method: POST
path: "/events/webhook"
---

# Add Webhook

`POST /events/webhook`

A Webhook (also called a web callback or HTTP push API) is a way for an app to provide other applications with real-time information. A `webHookUri` is generated which can be used for the integration.

## Request body

- object
  - `transformerType` 'WebEngageTransformer', required — Currently, only WebEngageTransformer is supported.
  - `tillCode` string, required — Till code to associate with the current Webhook. All events data that are posted through the current Webhook’s URL will be associated to this store TILL.
  - `authEnabled` boolean — To enable the authentication
  - `authMechanism` string — Defines the authentication mechanism
  - `uniquenessCheckEnabled` boolean — Enable or disable the uniqueness check.

## Response `200`

200

- object
  - `transformerType` string
  - `uniquenessCheckEnabled` boolean
  - `tillCode` string
  - `webHookUri` string
  - `authEnabled` boolean
  - `warnings` unknown[]
    - unknown

## Other responses

- `400` — 400

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/revisions/de241f2ed9b3/schema)