Integration

One push endpoint. Regent governs and dispatches, and the operation resource is where you read the outcome.

DEMO · SYNTHETIC DATAThis console is a public product tour served from synthetic fixtures. There is no login, no tenant credential in the page, and no connection to a Regent backend. A real tenant console requires a server-side session boundary before a browser may reach tenant-scoped APIs.

DEMO · SYNTHETIC DATAThe token in the sample below is the placeholder <tenant-token>. There is no real credential anywhere in this page or in the demo dataset, and this console never calls a Regent API.

Push a governed requesthttp

POST /v1/engage
Authorization: Bearer <tenant-token>
Content-Type: application/json

{
  "request_id": "req_01J...",
  "subject_id": "subject_441",
  "schema_version": "customer-snapshot.v1",
  "expected_config_version": "cfg_12",
  "snapshot": {
    "timezone": "Africa/Cairo",
    "conversation_summary": "..."
  },
  "delivery": {
    "recipient": "<tenant-asserted address>",
    "template_ref": "followup_v2",
    "language": "en"
  },
  "subject_sequence": 18
}

Illustrative request. Field names follow the public contract; response details are documented on the developer page and are marked illustrative where the backend response shape is not yet signed.

What the contract guarantees

Tenant identity. Tenant identity comes from authentication only, never from the request body.
Push-only. Push-only. You call Regent on your own trigger cadence; Regent does not connect to your EMR, CRM or any other system, and you do not maintain a webhook to receive decisions.
Idempotency. Same request_id with the same semantic content is a retry and returns the original operation. Same request_id with different content is an idempotency-reuse conflict.
Sequence. subject_sequence is informational only — it is echoed in the audit record and never enforced.
Dispatch. Regent governs and dispatches from your own WhatsApp Business identity through your provisioned Meta connection. Your number and business account remain yours; Regent owns the governed send operation and its provider lifecycle record.
Config check. expected_config_version is a check, never a choice — a mismatch is reported, not silently resolved.

Full field reference, outcome table and error shapes: the developer page →