Webhooks, Forms and the API

Three ways other systems meet Inkwell: webhooks that tell them when something happened, forms that collect something from readers, and a JSON API for reading content.

Webhooks

Desk, Webhooks: give a URL, choose events (post published, comment approved, member confirmed, newsletter sent, and so on), and optionally a secret. Each event is delivered as a signed JSON POST by the job runner with retries and a per-delivery log, so a receiver that was down gets the event later rather than never.

Forms

Build a form in the Desk, drop it into a page or post with its snippet, and submissions land under Forms with an e-mail notification if mail is set up. Spam protection is the same signed token and scoring the comment form uses. Submissions can be exported and are pruned on a retention schedule you set.

The API

A read API at /api with bearer-token authentication returns posts, pages, categories and tags as JSON for a mobile app or a second front end. Tokens are issued per user from the profile page and can be revoked. Everything the public site shows is available; nothing unpublished is.

See newsletters for the event most people wire first, and hosting for where the delivery log lives.