---
search:
  tags:
    - Webhook endpoints
    - POST
seo:
  description: >-
    Registers a delivery URL. The response contains the signing secret exactly…
    Reference for the POST /webhook-endpoints endpoint in the TipPage Developer
    API.
sidebar:
  label: Add an endpoint
  badge: POST
title: Add an endpoint
type: openapi-operation
---
Registers a delivery URL. The response contains the signing `secret` **exactly once** - store it immediately. URLs must be public `https://`; private/internal addresses are rejected. Max 10 endpoints. Requires `webhooks:manage`.

`POST /webhook-endpoints`

**Request body** (`application/json`, required)

- `url` (string<uri>, required) — Public https:// URL.
- `description` (string)
- `events` (string[], required) — Event types to receive, or \`\["\*"\]\` for everything.

Request body example:

```json
{
  "url": "http://example.com",
  "description": "string",
  "events": [
    "string"
  ]
}
```

**Responses**

- `201` — Created. \`secret\` is shown only here (and on rotation).
- `400` — Invalid URL, events, or endpoint limit reached.
- `401` — Missing or invalid credential (\`missing\_api\_key\` / \`invalid\_api\_key\`, or \`invalid\_token\` for an expired/revoked OAuth access token).
- `403` — The key lacks the required scope (\`missing\_scope\`).
- `429` — Rate limit exceeded - check the \`RateLimit-\*\` headers.

Response example, 201:

```json
{
  "endpoint": {
    "id": "we_1a2b3c4d5e6f",
    "url": "http://example.com",
    "description": "string",
    "events": [
      "string"
    ],
    "is_active": true,
    "disabled_reason": "string",
    "consecutive_failures": 0,
    "last_success_at": "2019-08-24T14:15:22Z",
    "last_failure_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z"
  },
  "secret": "whsec_9f8e7d..."
}
```
