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

# Register a webhook

`POST /v1/webhooks/`

## Request

- Base URL: `https://api.picsha.ai`
- URL: `https://api.picsha.ai/v1/webhooks/`
- Auth: HTTP bearer

## Headers

- `x-org-id` string
- `x-external-user-id` string

## Request body

- object
  - `url` string, uri, required
  - `events` string[], required
  - `secret` string
  - `config` object
    - `include_embeddings` boolean
    - `include_text` boolean

## Response `200`

Default Response

- object
  - `id` number, required
  - `url` string, required
  - `events` string[], nullable, required
  - `secret` string, nullable, required
  - `config` unknown, required

## Other responses

- `403`: Default Response

---

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