---
title: "Add Webhook"
method: POST
path: "/webHooks"
---

# Add Webhook

`POST /webHooks`

Add a new webhook.

## Request body

- object
  - `active` boolean, required — Indicates if the webhook is active.
  - `customerIdentifiersToBeEnriched` string[], required — List of customer identifiers to be enriched.
  - `eventNames` string[], required — List of event names that trigger the webhook.
  - `maxAllowedConnections` integer, required — Maximum connections allowed at the same time for this webhook.
  - `methodType` string, required — HTTP method used by the webhook. Example: POST, PUT, GET or DELETE.
  - `name` string, required — Name of the webhook.
  - `slaInSeconds` integer — Expected delivery time of the event notification in seconds.
  - `webHookHeaders` string[], required — Headers sent with the webhook request.
  - `webHookType` string, required — Type of webhook, Example: HTTP
  - `webHookUrl` string, required — URL where the webhook sends its requests.

## Response `200`

200

- object
  - `data` object
    - `attribution` object
      - `createdOn` string
      - `lastUpdatedOn` string
      - `lastUpdatedBy` object
        - `id` integer
        - `code` string
        - `description` string
        - `name` string
        - `type` string
      - `createdBy` object
        - `id` integer
        - `code` string
        - `description` string
        - `name` string
        - `type` string
    - `webHookId` string
    - `name` string
    - `eventNames` string[]
    - `webHookUrl` string
    - `webHookType` string
    - `methodType` string
    - `webHookHeaders` object
      - `Authorization` string
      - `Content-Type` string
    - `noOfRetryAttempts` integer
    - `maxAllowedConnections` integer
    - `active` boolean
    - `slaInSeconds` integer
    - `consumerGroupId` string
    - `tillDetailsEnrichmentEnabled` boolean
    - `storeDetailsEnrichmentEnabled` boolean
    - `customerIdentifiersToBeEnriched` unknown[]
      - unknown
    - `awardedReferenceEnrichmentEnabled` boolean
    - `availablePointsBalanceEnrichmentEnabled` boolean
  - `errors` unknown
  - `warnings` 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)