---
title: "Create a webhook configuration"
method: POST
path: "/v0/webhook-configurations"
tags: ["Webhook Configurations"]
---

# Create a webhook configuration

`POST /v0/webhook-configurations`

## Request

- Base URL: `https://distributor-api.spiko.io`
- URL: `https://distributor-api.spiko.io/v0/webhook-configurations`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/spiko/apis/spiko-distributor-api/docs/v0/webhook-configurations/post.ts> (a function with typed inputs; its response is checked against the schema)

Register a new webhook endpoint. The signing secret is returned only in this response - store it securely.

## Request body

- object
  - `url` string, required
  - `topics` string[], required

## Response `200`

Success

- object
  - `id` string, uuid, required: a Universally Unique Identifier
  - `distributorId` string, uuid, required: a Universally Unique Identifier
  - `url` string, required
  - `topics` string[], required
  - `signingSecret` string, required
  - `previousSigningSecret` string, nullable, required
  - `secretRotatedAt` string, nullable, required: A valid date within the range 2020-2100
  - `status` 'active' | 'disabled' | 'circuit-broken', required
  - `consecutiveFailures` integer, required
  - `createdAt` string, required: A valid date within the range 2020-2100
  - `updatedAt` string, required: A valid date within the range 2020-2100

## Other responses

- `400`: The request did not match the expected schema
- `401`: Authentication failed. Two bodies are possible: the schema below when the API rejects the credentials, and `{ "error": { "code", "status", "request", "message" } }` when the API gateway rejects them first. Only the former carries a `_tag`.
- `403`: Forbidden
- `503`: The investor is undergoing a scheduled upgrade, access is temporarily paused to ensure data safety.

---

[API](https://skmtc.dev/spiko/apis/spiko-distributor-api.md) - [All operations](https://skmtc.dev/spiko/apis/spiko-distributor-api/llms.txt) - [OpenAPI document](https://skmtc.dev/spiko/apis/spiko-distributor-api/revisions/ad85137fd00b?raw)