---
title: "Register webhook"
method: POST
path: "/v1/webhooks"
tags: ["webhooks"]
---

# Register webhook

`POST /v1/webhooks`

## Request

- Base URL: `https://api.framelane.io`
- URL: `https://api.framelane.io/v1/webhooks`
- Auth: HTTP bearer

Register an HTTPS endpoint to receive job events. The signing secret is returned once — use it to verify HMAC signatures on payloads.

## Request body

- WebhookCreate
  - `url` string, uri, required
  - `events` WebhookEvent[]
  - `enabled` boolean

## Response `201`

Successful Response

- WebhookCreated: Returned at create-time and after rotate-secret -- includes plaintext secret.
  - `id` string, required
  - `url` string, required
  - `events` string[], required
  - `enabled` boolean, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `secret` string, required

## Other responses

- `401`: Missing or invalid API key.
- `422`: Validation Error

---

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