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

# Register a webhook endpoint

`POST /api/v1/webhook-endpoints`

## Request

- Base URL: `https://app.dodomain.io`
- URL: `https://app.dodomain.io/api/v1/webhook-endpoints`
- Auth: HTTP bearer

Registers one delivery target and returns its signing secret **once**. `secret` (`whsec_...`) appears in this response and in a rotate response, and in no read surface ever again — store it now. The URL must be https and must not resolve to a localhost/private/link-local address, and an app cannot register the same normalized URL twice: both refusals are `400 invalid_request` with the reason in `message`. A hostname that resolves only to private, reserved, CGNAT or loopback addresses is refused the same way, with `details.reason = webhook_url_resolves_private` for clients that branch on it (a host that does not resolve yet is accepted). At the plan's endpoint cap it is `402 quota_exceeded`.

## Headers

- `DoDomain-Team` string

## Request body

- WebhookEndpointInput
  - `url` string, required

## Response `201`

Success.

- WebhookEndpointSecretResponse
  - `appId` string, required
  - `createdAt` string, date-time, required
  - `id` string, required
  - `pausedAt` string, date-time, nullable, required
  - `secret` string, required
  - `url` string, required

## Other responses

- `400`: `400 invalid_request` — The request body or query failed schema validation, or a documented capability rule rejected it. `details` carries the field-level report when the failure came from schema validation.
- `401`: `401 unauthorized` — No `Authorization: Bearer` header, or the credential is malformed, unknown, or (for OAuth tokens) fails verification.
- `402`: `402 quota_exceeded` — The team's monthly verified-connection allowance is exhausted (enforced at session creation on the Free plan).
- `403`: `403 forbidden` — The OAuth access token was not granted the scope this operation requires. `details.code` is `SCOPE_MISSING` and `details.requiredScope` names the scope. Secret keys (`dd_sk_`) carry no scopes and never see this for a missing scope. The one-click start routes also answer it for a session created without one-click (a Free-plan team's session): no `details`, and the end user falls back to the manual records.
- `404`: `404 not_found` — The addressed resource does not exist, or the caller does not own it — the two collapse to one status on purpose, so an id cannot be enumerated by a caller who does not own it.
- `429`: `429 rate_limited` — Rate limited. `Retry-After` (seconds) is set and `details.retryAfterSeconds` repeats it. Branch on `details.reason`: `request_rate` means the caller is calling too fast (`details.limit` carries the cap), `recently_checked` means this one connection was DNS-checked inside its cooldown.
- `500`: `500 internal` — An unhandled server-side failure. Reported to our error tracker; safe to retry.

---

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