---
title: "Create an endpoint; secret is returned once"
method: POST
path: "/webhook-endpoints"
tags: ["Webhooks"]
---

# Create an endpoint; secret is returned once

`POST /webhook-endpoints`

## Request

- Base URL: `https://api.promptessor.com/v1`
- URL: `https://api.promptessor.com/v1/webhook-endpoints`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://auth.promptessor.com/authorize`
    - Token URL: `https://auth.promptessor.com/token` scopes: `webhooks:manage`

## Request body

- object
  - `url` string, uri, required: Must be a public HTTPS URL.
  - `description` string
  - `events` string[], required

## Response `200`

Success

- object
  - `data` WebhookEndpoint, required
    - `id` string, required
    - `object` 'webhook_endpoint', required
    - `url` string, uri, required
    - `description` string, nullable, required
    - `events` string[], required
    - `enabled` boolean, required
    - `lastDeliveryAt` string, date-time, nullable, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `secret` string
  - `requestId` string, required

## Other responses

- `400`: Invalid request
- `401`: Authentication failed
- `403`: Insufficient scope or plan entitlement
- `409`: Resource state or idempotency conflict
- `429`: Rate, concurrency, usage, or active-resource limit reached
- `500`: Unexpected server failure
- `503`: A required dependent service is unavailable

---

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