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

# Create a webhook endpoint

`POST /webhook-endpoints`

## Request

- Base URL: `https://api.braiv.co/v1`
- URL: `https://api.braiv.co/v1/webhook-endpoints`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`

Registers an HTTPS destination. Store the signing secret immediately; it is returned only once. Required scope: `webhooks:write`.

## Headers

- `Idempotency-Key` string

## Request body

- CreateWebhookEndpointRequest
  - `url` string, uri, required: Public HTTPS delivery destination.

## Response `201`

Endpoint created and one-time signing secret returned.

- WebhookEndpointCreated
  - `id` string, required: Created webhook endpoint ID.
  - `url` string, uri, required: Registered HTTPS delivery destination.
  - `secret` string, required: Signing secret returned once at creation.
  - `events` WebhookEventName[], required: Event names delivered to this endpoint.

## Other responses

- `400`: Request fields are missing, malformed, out of bounds, or mutually inconsistent.
- `401`: A supported authentication header is missing or contains an invalid Public API key.
- `403`: Authentication succeeded, but the required scope, workspace role, or resource permission is missing.
- `409`: The Idempotency-Key was reused with a different path or request body.
- `429`: The API key exceeded its allowed concurrency or request rate. Retry after in-flight work completes or the limit resets.
- `500`: An unexpected server error occurred.

---

[API](https://skmtc.dev/braiv/apis/braiv-public-api.md) - [All operations](https://skmtc.dev/braiv/apis/braiv-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/braiv/apis/braiv-public-api/revisions/8ed0fd0d0a6f?raw)