---
title: "Create a webhook"
method: POST
path: "/v1/webhooks"
tags: ["Webhooks"]
---

# Create a webhook

`POST /v1/webhooks`

Registers a new webhook endpoint.

---

#### See also  
Learn more about [Webhooks](./webhooks-guide)

## Request body

- WebhookCreate
  - `name` string
  - `status` 'online' | 'offline'
  - `type` 'user' | 'system'
  - `url` string, url, required
  - `events` string[], required — `Case.AssigneeUpdated`, `Case.ClientPortalWaitStepTriggered`, `Case.ContactHasActionsUpdated`, `Case.Created`, `Case.Deleted`, `Case.FlagsUpdated`, `Case.InfoUpdated`, `Case.MetadataUpdated`, `Case.ReviewConfirmed`, `Case.ReviewDue`, `Case.ReviewUpdated`, `Case.ReviewerHasActionsUpdated`, `Case.RiskUpdated`, `Case.StatusUpdated`, `Case.TagsUpdated`, `Case.TemplateUpdated`, `Case.Updated`, `CaseReport.Generated`, `Check.Approved`, `Check.Deleted`, `Check.Expired`, `Check.Rejected`, `Check.ReviewNeeded`, `Check.Started`, `Company.Created`, `Company.Deleted`, `Company.InfoUpdated`, `Company.MarkedAsNotRelevant`, `Company.MarkedAsRelevant`, `Company.Updated`, `DocumentOrder.Completed`, `DocumentOrder.Failed`, `Individual.Created`, `Individual.Deleted`, `Individual.InfoUpdated`, `Individual.MarkedAsNotRelevant`, `Individual.MarkedAsRelevant`, `Individual.Updated`, `Note.Created`, `Note.Deleted`, `Note.Updated`, `NoteComment.Created`, `NoteComment.Deleted`, `NoteComment.Updated`
  - `secret` string — A secret token used to sign the webhook payload. Autogenerated if not set.

## Response `201`

The created webhook

**ℹ️ Click to see full payload**

- Webhook
  - `id` string, uuid, required
  - `name` string, required
  - `status` 'online' | 'offline', required
  - `type` 'user' | 'system', required — `system` webhooks are hidden from console app.
  - `events` string[], required
  - `url` string, url, required
  - `secret` string, required — A secret token used to sign the webhook payload.
  - `created_at` string, date-time, required — Creation date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
  - `updated_at` string, date-time, required — Latest update date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)

## Other responses

- `400` — The request is either malformed or contain invalid parameters. - Make sure the body payload matches the expected schema - Maximum items reached (default: 50). Contact us at support@dotfile.com if you need more items.

---

[API](https://skmtc.dev/dotfile/apis/api-specifications.md) · [All operations](https://skmtc.dev/dotfile/apis/api-specifications/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/dotfile/api-specifications/revisions/36393567057b/schema)