---
title: "Register a webhook; the secret is returned once"
method: POST
path: "/webhooks"
---

# Register a webhook; the secret is returned once

`POST /webhooks`

## Request

- Base URL: `https://clusters.soleilpictures.com/api/v1`
- URL: `https://clusters.soleilpictures.com/api/v1/webhooks`
- Auth: HTTP bearer

## Request body

- object
  - `workspace_id` string, uuid, required
  - `url` string, uri, required: Public https, default port
  - `events` string[], required: Event names, or ["*"]
  - `name` string

## Response `200`

Success

- object

## Other responses

- `400` (unresolved $ref)
- `403`: The token lacks the scope, or the account cannot reach that thing.
- `404`: No such thing — including things this account cannot see.

---

[API](https://skmtc.dev/soleilpictures/apis/soleil-clusters-api.md) · [All operations](https://skmtc.dev/soleilpictures/apis/soleil-clusters-api/llms.txt) · [OpenAPI document](https://skmtc.dev/soleilpictures/apis/soleil-clusters-api/revisions/1d426d587bf3?raw)