---
title: "Register a webhook endpoint"
method: POST
path: "/v1/webhooks"
tags: ["webhooks"]
---

# Register a webhook endpoint

`POST /v1/webhooks`

## Request

- Base URL: `https://api.portproof.org`
- URL: `https://api.portproof.org/v1/webhooks`
- Auth: HTTP bearer

The signing secret is shown once; deliveries carry `Portproof-Signature: t=<unix>,v1=<hex hmac-sha256(secret, t + "." + body)>`. Requires an `Idempotency-Key` header (CONTRACT §1): the same key with the same body within 24 h replays the stored response; a different body returns 409 `idempotency_conflict`.

## Request body

- object
  - `url` string, uri, required
  - `events` string[], required

## Response `201`

Default Response

- object
  - `id` string, required
  - `url` string, uri, required
  - `events` string[], required
  - `secret` string, required

## Other responses

- `400`: Default Response

---

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