---
title: "Create a webhook endpoint (the secret is shown only here)"
method: POST
path: "/v1/webhooks"
tags: ["Webhooks"]
---

# Create a webhook endpoint (the secret is shown only here)

`POST /v1/webhooks`

## Request

- Base URL: `https://api.castpdf.com`
- URL: `https://api.castpdf.com/v1/webhooks`
- Auth: HTTP bearer

## Request body

- object
  - `url` string, required
  - `description` string, nullable
  - `events` string[], required
  - `mode` 'live' | 'test'

## Response `201`

OK

- object
  - `id` string, uuid
  - `url` string, uri
  - `description` string, nullable
  - `events` string[]
  - `mode` 'live' | 'test'
  - `status` 'enabled' | 'disabled'
  - `disabled_reason` 'manual' | 'failing' | 'null', nullable
  - `secret_prefix` string
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `secret` string

## Other responses

- `default`: Error

---

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