---
title: "POST /api/v1/webhooks"
method: POST
path: "/api/v1/webhooks"
tags: ["Webhooks"]
---

# POST /api/v1/webhooks

`POST /api/v1/webhooks`

## Request

- Base URL: `https://xquik.com`
- URL: `https://xquik.com/api/v1/webhooks`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Registers an endpoint for signed event deliveries.

## Request body

- object
  - `url` string, uri, required: HTTPS URL. A Discord channel webhook or a Slack incoming webhook URL gets chat messages. The events of 1 post come as 1 alert, & alerts that wait together as 1 digest. A busy channel gets 5 quick messages, then 1 every 30 s. To deliver to Telegram, use POST /webhooks/telegram instead.
  - `eventTypes` EventType[], required: Array of event types to subscribe to.

## Response `201`

Webhook created

- object
  - `ignoredFields` IgnoredFields (unresolved $ref)
  - `id` string, required
  - `url` string, uri, required
  - `secret` string, required: Plaintext HMAC signing secret returned only at creation.
  - `eventTypes` EventType[], required: Array of event types to subscribe to.
  - `createdAt` string, date-time, required

## Other responses

- `400`: Invalid input. A value past its maxLength gets this answer, & the message names the field & its limit.
- `401`: Unauthenticated
- `429`: Too many requests right now. Each user gets 500 reads a second. Each minute allows 120 writes & 60 deletes. `x_api_rate_limited` means X limits this read for now. Neither answer costs anything. Wait for the seconds in `Retry-After`, then retry.
- `500`: Unexpected error.
- `default`: Unexpected error.

## Changes

- **2026-10-20** `45942c75fdc2`: 10 warning
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #2: StructuredError]/code` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `400`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `401`
  - …6 more

[Operation history](https://skmtc.dev/xquik-dev/apis/xquik-api/changes/api/v1/webhooks/post.md)

---

[API](https://skmtc.dev/xquik-dev/apis/xquik-api.md) · [All operations](https://skmtc.dev/xquik-dev/apis/xquik-api/llms.txt) · [OpenAPI document](https://skmtc.dev/xquik-dev/apis/xquik-api/revisions/45942c75fdc2?raw)