Choose the direction of the connection
| Interface | Use it when |
|---|---|
| Webhook | VeloWrite should send an article snapshot to your receiving service. |
| CLI | A local script needs to submit or inspect a publishing job. |
| Local API | A local application needs authenticated HTTP access. |
| MCP | An MCP client should call Publisher tools through the local bridge. |
Webhooks: start with a test receiver
Configure an HTTPS receiver and signing secret in Publisher. The receiver must verify the signature and keep an idempotency record before performing an action. A generic HTTP 200 response is not enough: VeloWrite expects a structured receipt that identifies the same operation.
Give each configured receiver a clear name and test it separately. Decide which downstream actions can publish publicly. A timeout leaves an uncertain result; check the receiver's record before sending the article again. Never paste a production secret into screenshots or support messages.
Local automation prerequisites
The optional bridge needs Python 3.10 or later and the native VeloWrite Publisher executable. Desktop writing and conversion do not need Python. Use an explicit Publisher data directory so your automation does not accidentally use another profile.
CLI: inspect capabilities first
The native executable reads a JSON request from standard input. A capability request lets you inspect the current access state before submitting work:
{"op":"capabilities"}For a workflow that creates jobs, use a stable submission ID. Reusing the same ID for different content is a conflict. Keep credentials out of command-line arguments and shell history.
Local API: keep the service on loopback
Set a random VELOWRITE_API_TOKEN of at least 32 characters, then run the bridge with an absolute executable path and a private profile directory:
python scripts/publisher_bridge.py --binary ABSOLUTE_CLI_PATH --data-dir PUBLISHER_DIRECTORY --httpThe default address is 127.0.0.1:41791. Requests require an Authorization: Bearer token header. Start with GET /v1/capabilities. Do not expose this local service to the internet or place its token in a page URL.
MCP: use the stdio bridge
Configure your MCP client to launch Python with the bridge path, --binary, and --data-dir arguments. Omit --http to use stdio. The tools are publisher_capabilities, publisher_jobs, and publisher_request. Inspect the capabilities and review the requested operation before allowing an external delivery.
Test without publishing
Begin with a simulation and a short sample article. Check the queued snapshot and history, then move to a test account or receiver. A proxy can provide network access; it cannot grant platform permissions or replace a valid subscription.
Publisher walkthrough · Local storage and connection security · Ask for integration help