Set or clear the webhook URL

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.

put/api/me/webhook

Request

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

Request body

urlstring nullable

https:// URL, or empty/null to clear

Response

{ ok: true, webhook_url }

Changes

No recorded changes to this operation across all 1 revision of this API.