Register a webhook

The only write on this API. Registers an https endpoint to be told when the knowledge base is re-ingested, instead of polling /changelog.

The response carries a secret, shown once and never again: it signs every delivery and authorises reading and deleting this subscription.

The URL must be https and must resolve to a public address. Redirects are not followed.

post/webhooks

Request

  • Base URL: https://vineverse.bible/api/v1
  • URL: https://vineverse.bible/api/v1/webhooks
  • Auth: none required

Query parameters

sandboxboolean

Validate the request and return a realistic response, storing and delivering nothing. The same validation runs either way, so a request that succeeds here succeeds for real.

Request body

urlstring uri required

Must be https, and must resolve to a public address. Private, loopback and link-local addresses are refused, including a public hostname that resolves to one.

eventsstring[]

Omit for all events.

Response

Sandbox: validated, nothing stored.

secretstring

Shown once. Signs every delivery, and authorises GET and DELETE.

sandboxboolean

Present and true when nothing was stored.

notestring

Changes

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