Introduction
Run reviewed Keepable workflows from your backend, then reconcile delivery, participants, claims, responses, and permission changes.
The Sender API is a small server-to-server execution surface at
https://api.keepable.co/sender/v2. Your team designs and publishes a workflow
as a plan in Keepable Workspace. Your integration supplies the changing
inputs, runs that plan, and reads the resulting correspondence.
The API is deliberately not Workspace over HTTP. Team administration, workflow authoring, billing, API-key management, webhook configuration, exports, and operator recovery remain in Workspace.
Start here
The model
How a published plan becomes correspondence.
API reference
The generated reference for the complete public surface.
The integration loop
Configure in Workspace. Publish the plan, configure webhook delivery, and mint an API key with only the scopes this integration needs.
Discover the plan. Read GET /plans or GET /plans/{plan_id} to learn
its required parameters, documents, and recipient shape.
Upload inputs and run it. Upload any file through POST /documents,
then call POST /plans/{plan_id}/runs.
Reconcile the result. Follow webhooks or read the correspondence, participants, claims, responses, and permission-change feed.
A first run
Assume Workspace contains an active plan named “Monthly payslip”. The plan owns the message, delivery rules, and retention policy; this request supplies the employee and this month's PDF.
POST https://api.keepable.co/sender/v2/plans/pln_01J8ZQ4T/runs
Authorization: Bearer {{KEEPABLE_TOKEN}}
Idempotency-Key: 5f3c1e02-9b7a-4a11-8c2e-6d0f4b8a1c93
Content-Type: application/json
{
"subject": "Your March payslip",
"document_ids": ["doc_01J8ZQ4T"],
"recipients": [
{
"addressing": { "type": "nin", "nin": "12345678901" },
"display_name": "Musa Bello",
"ref": "EMP-4471"
}
]
}The call answers 202 with a Correspondence. Delivery continues
asynchronously. Persist its correspondence_id, handle
correspondence.send_completed, and use the read endpoints when you need the
current state.
There is no public POST /correspondence. Creating an ad hoc workflow is a
Workspace operation. Every API-created correspondence comes from running a
reviewed plan.