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

# Create a new webhook endpoint

`POST /webhooks`

Register a new webhook endpoint to receive event notifications

## Request body

- CreateWebhookParams — Request body for creating a new webhook endpoint
  - `eventTypes` WebhookEventType[], nullable — Optional array of event types to subscribe to. Nothing means subscribe to all event types.
  - `filterPaths` ResourceField[], nullable — Optional array of resource field paths to filter events by. When specified, webhook events will only be sent when one of these fields changes. Nothing means no filtering (all events are sent).
  - `url` string, required — The URL to which webhook events will be delivered

## Response `200`

- ApiWebhookResponse — Webhook configuration details
  - `createdAt` string, yyyy-mm-ddThh:MM:ssZ, required — When the webhook was created
  - `eventTypes` WebhookEventType[], nullable — Optional array of event types this webhook is subscribed to. Nothing means all events.
  - `filterPaths` ResourceField[], nullable — Optional array of resource field paths to filter events by. Nothing means no filtering.
  - `id` string, uuid, required — Unique identifier for the webhook endpoint
  - `secret` string, nullable — Webhook signing secret. Only returned on creation (POST), not on GET or UPDATE operations.
  - `status` 'active' | 'paused' | 'disabled', required — Current status of the webhook (active, paused, or disabled)
  - `updatedAt` string, yyyy-mm-ddThh:MM:ssZ, required — When the webhook was last updated
  - `url` string, required — The URL that will receive webhook POST requests

## Other responses

- `400` — Invalid `body`

---

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