---
title: "Register an https:// URL for generation.succeeded / generation.failed events. The signing secret is in this response only. API keys only."
method: POST
path: "/v1/webhook-endpoints"
---

# Register an https:// URL for generation.succeeded / generation.failed events. The signing secret is in this response only. API keys only.

`POST /v1/webhook-endpoints`

## Request

- Base URL: `https://api.lumeta.ai`
- URL: `https://api.lumeta.ai/v1/webhook-endpoints`
- Auth: HTTP bearer

## Request body

- object
  - `url` string, uri, required: https:// on port 443, resolving to a public address.
  - `events` string[]: ["*"] (the default) for every event.
  - `enabled` boolean: PATCH only. true also clears the failure count.

## Response `201`

OK

- object
  - `id` string: `hook_<n>`
  - `url` string
  - `events` string[]: ["*"] or a list of generation.succeeded, generation.failed.
  - `enabled` boolean: false after you switch it off, or after an event failed every retry with no success in between.
  - `failure_count` integer: Failed attempts in a row; a 2xx resets it.
  - `last_success_at` string, nullable
  - `last_failure_at` string, nullable
  - `disabled_at` string, nullable
  - `created_at` string
  - `secret` string: whsec_...: signs every event to this endpoint. Returned here only.
  - `secret_note` string

## Other responses

- `default`: Error

---

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