---
title: "New Endpoint"
method: POST
path: "/endpoints"
---

# New Endpoint

`POST /endpoints`

## Request

- Base URL: `https://webhook.api.sandbox.cleeng.com`
- URL: `https://webhook.api.sandbox.cleeng.com/endpoints`
- Auth: API key in header `X-Publisher-Token`

This is your first endpoint! Edit this page to start documenting your API.

## Request body

- object
  - `url` string, required: HTTPS URL to receive webhook deliveries. </br> _Example: "https://example.com/webhooks"_
  - `name` string: Human-readable endpoint name. </br>≤ 100 characters </br> Default: ""
  - `events` string[], required: Event types this endpoint subscribes to. </br> ≥ 1 items </br> _Example:_ </br> _#0"subscriptionCreated"_ </br> _#1"capturePayment"_
  - `retry` object
    - `maxAttempts` integer: Maximum number of delivery attempts (1 initial + retries). </br> Allowed values [1, 5] </br> Default: 4
  - `metadata` object: An object with arbitrary metadata. Key-value metadata (max 10 keys, keys ≤40 chars, values ≤500 chars).
    - `additionalProp1` string: Additional property. </br> ≤ 500 characters </br> Default: `empty object`

## Response `200`

Successful response

## Other responses

- `201`: Endpoint created successfully
- `400`: Validation error
- `409`: URL already registerd for this publisher
- `422`: Maximum endpoint limit reached

---

[API](https://skmtc.dev/cleeng/apis/webhooks-api.md) - [All operations](https://skmtc.dev/cleeng/apis/webhooks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cleeng/apis/webhooks-api/revisions/11c3ee3902ce?raw)