---
title: "POST /event/{tenantLocator}/webhooks"
method: POST
path: "/event/{tenantLocator}/webhooks"
---

# POST /event/{tenantLocator}/webhooks

`POST /event/{tenantLocator}/webhooks`

## Request

- Base URL: `https://docs.socotra.com`
- URL: `https://docs.socotra.com/event/{tenantLocator}/webhooks`
- Auth: none declared
- TypeScript: <https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/docs/event/:tenantLocator/webhooks/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `tenantLocator` string, uuid, required

## Request body

- CreateWebhookRequest
  - `name` string, required
  - `enabled` boolean, required
  - `eventTypes` string[], required
  - `endpoint` CreateEndpointRequest, required
    - `url` string, required
    - `headers` object
    - `secureSsl` boolean
    - `hmacEnabled` boolean
    - `secret` string
    - `tag` string
  - `failureHandling` FailureHandlingCreateRequest, required
    - `alertEndpoint` CreateEndpointRequest, required
      - `url` string, required
      - `headers` object
      - `secureSsl` boolean
      - `hmacEnabled` boolean
      - `secret` string
      - `tag` string
    - `triggers` string[], required
    - `retryStrategy` RetryStrategyCreateRequest, required
      - `type` 'linear' | 'exponential', required
      - `interval` integer, required
      - `attempts` integer, required
    - `divert` boolean, required
    - `suspend` boolean, required
  - `useAutomationPlugin` boolean

## Response `200`

OK

- WebhookResponse
  - `locator` string, ulid, required
  - `name` string, required
  - `enabled` boolean, required
  - `suspended` boolean, required
  - `suspendedAt` string, date-time, required
  - `eventTypes` string[], required
  - `endpoint` EndpointResponse, required
    - `url` string, required
    - `headers` object, required
    - `secureSsl` boolean, required
    - `hmacEnabled` boolean, required
    - `secret` string, required
    - `tag` string, required
  - `failureHandling` FailureHandlingResponse, required
    - `alertEndpoint` EndpointResponse, required
      - `url` string, required
      - `headers` object, required
      - `secureSsl` boolean, required
      - `hmacEnabled` boolean, required
      - `secret` string, required
      - `tag` string, required
    - `triggers` string[], required
    - `retryStrategy` RetryStrategyResponse, required
      - `type` 'linear' | 'exponential', required
      - `interval` integer, required
      - `attempts` integer, required
    - `divert` boolean, required
    - `suspend` boolean, required

---

[API](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi.md) - [All operations](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/revisions/77ee7d8172b9?raw)