---
title: "Set or clear the webhook URL"
method: PUT
path: "/api/me/webhook"
---

# Set or clear the webhook URL

`PUT /api/me/webhook`

## Request

- Base URL: `https://bol.ai`
- URL: `https://bol.ai/api/me/webhook`
- Auth: HTTP bearer

Every completed extraction (upload, batch, API, email-in) is POSTed to this https URL as { id, filename, doc_type, doc_label, status, fields, warnings }. Clear by sending an empty url. Test delivery with POST /api/me/webhook/test.

## Request body

- object
  - `url` string, nullable: https:// URL, or empty/null to clear

## Response `200`

{ ok: true, webhook_url }

## Other responses

- `400`: Not an https:// URL

---

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