Docsbook
Overview

Register webhook search popular

POST/api/v1/register_webhook_search_popular

Register a webhook for the 'search_popular' event (BUSINESS) — the direct call for 'notify us when…', 'alert me if…', 'ping our channel when…' about this event. Fires when a search query crosses a popularity threshold. Delivery is an asynchronous HTTP POST. A Slack (hooks.slack.com) or Discord (discord.com/api/webhooks) incoming-webhook URL is recognised by its host and the message shaped for that platform — paste it as-is; any other URL receives the signed JSON envelope (HMAC-SHA256 in X-Docsbook-Signature-256, event type in X-Docsbook-Event). Below the BUSINESS plan the call returns PLAN_RESTRICTION naming the tier — no pre-check needed.

Price — $0.00001 per call (twice what serving it costs us), charged to the workspace balance, the same as over MCP.

Also reachable by name at POST /api/v1/tools/register_webhook_search_popular.

Authorization
Authorizationstringrequired

Your API key, sent as Authorization: Bearer dbk_YOUR_API_KEY.Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.

Body
urlstring

HTTPS endpoint to receive POST callbacks

secretstring

Optional shared secret (>=16 chars). One is generated if omitted.

auth_headerstring

Optional Authorization header value sent verbatim on delivery, e.g. 'Bearer sk-…' for endpoints that require auth (Claude Code routine fire URLs).

Request
curl -X POST 'https://docsbook.io/api/v1/register_webhook_search_popular' \
  -H 'Authorization: Bearer dbk_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses#

Status Meaning
200 The tool ran. Read ok to see whether it succeeded.
401 Missing or invalid API key.

Updated

Was this page helpful?