---
title: "Register a workspace webhook endpoint"
method: POST
path: "/v1/webhooks"
---

# Register a workspace webhook endpoint

`POST /v1/webhooks`

## Request

- Base URL: `https://api.uploadcheck.app`
- URL: `https://api.uploadcheck.app/v1/webhooks`
- Auth: HTTP bearer

Registers a signed webhook endpoint. Stored workspace API keys force server-side workspace, owner, and key metadata onto the endpoint, ignoring client-supplied workspace fields.

## Request body

- object
  - `url` string, required
  - `event_types` string[]

## Response `201`

Webhook registered

- WebhookEndpoint
  - `webhookId` string
  - `url` string
  - `eventTypes` string[]
  - `workspaceId` string, nullable: Workspace that owns this webhook endpoint. Stored workspace API keys are pinned to this value.
  - `ownerEmail` string, nullable
  - `apiKeyId` string, nullable
  - `signingSecretPreview` string
  - `signingSecret` string: Returned once on creation.
  - `signingSecretStorage` 'encrypted' | 'plaintext'

---

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