Availability — engagement runs through Tasks, for enabled organizations.
Patient engagement is delivered by creating a Task with an engagement
task_type
and is available to organizations that have it provisioned during onboarding.
There are no engagement-specific endpoints — no separate outreach or
messaging API. If engagement is not enabled for your organization, ask your
Synthpop contact. The voice agent is one
engagement channel and has its own page.What it does
Healthcare cases stall on small, human gaps: a form the patient never returned, a number that needs confirming, a question only the patient can answer. Engagement closes those gaps programmatically:- Voice outreach. The voice agent places and handles patient phone calls on your behalf, has the conversation, and returns a structured outcome you can act on.
- Digital outreach. Reach patients through digital channels to collect or confirm information without a manual call.
- Closed loop. Whatever the channel, the outcome comes back on the Task — the
same
TaskDetailsshape you already read — so a completed engagement flows straight back into your workflow.
How it fits the Task model
Engagement introduces no new resource and no new endpoints. It is the ordinary create → process → read loop with an engagementtask_type:
1
Create an engagement Task
POST /task/create with an engagement task_type and whatever context the
outreach needs (for example, a request_spec describing what to collect, or an
external_id correlating the Task to a case in your system).patient_outreach here is an illustrative placeholder, not a real value.
Engagement task_types are provisioned per organization during onboarding;
your Synthpop contact tells you the concrete value to use. Passing an
unprovisioned type returns 400 "Task type 'X' not in list of tasks for your organization: [...]."2
Synthpop runs the outreach
The Task moves through
processing while Synthpop carries out the outreach.
Engagement can take time — a patient may not answer immediately — so, as with
every Task, you observe progress asynchronously rather than blocking on the
create call. (See voice agent capabilities
for what a call can do, and Trust & safety for
why you can rely on the outcome.)3
Read the outcome
Poll
GET /task/get (or receive an opt-in callback) until the Task reaches a
terminal status. The result — what was collected or confirmed — comes back as
Data Items and, where applicable,
Results on the same TaskDetails. If the Task needs more
from you first, it pauses at waiting; see
Responding to waiting tasks.Engagement Tasks are asynchronous, like the rest of the API.
POST /task/create returns immediately with status: "pending"; the outcome exists
only after the Task reaches a terminal status. See
Working with async results. Statuses are exactly
pending, processing, waiting, completed, failed, invalid.Channels
Voice agent
Place and handle patient phone calls, and read back a structured outcome.
Digital outreach
Reach patients through digital channels to collect or confirm information —
created and read exactly like any other Task.
Voice agent capabilities
What the voice agent can do on a call, and the guardrail behind each
capability.
Trust & safety
Why you can rely on what a call says and does.
Good to know
No engagement-specific endpoints
No engagement-specific endpoints
Everything runs through the same handful of Task endpoints in the
API reference. The
task_type you pass on
create is the only lever that turns a Task into an engagement Task — there is no
separate outreach, messaging, or telephony API.Correlate engagement to the case that triggered it
Correlate engagement to the case that triggered it
Set
external_id on create to tie an engagement Task back to the intake or
coverage case it follows up on, then find related Tasks with
GET /task/list. There is no parent/child field on the
Task — you correlate with your own identifiers.Engagement is provisioned, not self-serve
Engagement is provisioned, not self-serve
Engagement
task_types are enabled per organization. If you don’t see the
behavior described here, engagement likely isn’t provisioned for your org yet —
your Synthpop contact can confirm what’s enabled.Where to go next
Voice agent
The voice channel in detail.
Voice agent capabilities
What voice can do on a call, and the guardrail behind each capability.
Trust & safety
Why you can rely on what a call says and does.
The patient journey
How intake, coverage, and engagement read as one flow.
Tasks
The core resource and its status lifecycle.
Validate an order
The concrete end-to-end Task pattern engagement reuses.