Engagements

Get member context for an engagement

Changed on

Requires scope: engagement:context

All callers with the base scope receive member_verified, intent, category, and mx_agent alongside the other basic identifying fields. Callers additionally granted engagement:context:full (internal Clover systems only) also receive master_record_id, support_team, member_preferred_buddy, member_preferred_buddy_worker_sid, member_preferred_buddy_matched, lh_balance (the flag the IVR sets when a member presses 1 for Livehealthy rewards), and the Engagement's full metadata blob. External callers without that scope never see those keys, regardless of their values.

member_preferred_buddy_worker_sid is the TaskRouter Worker for a buddy the member asked for by name on a Flora call — offer the call to that Worker first, then fall through to support_team. Null when no buddy was asked for, or the name matched nobody or more than one person. member_preferred_buddy_matched names who it matched and how, e.g. "Anthony Vargas (nickname)" for a member who asked for "Tony".

mx_agent is a flat boolean written by the Twilio IVR via PATCH /{engagement_id}/context/metadata (metadata["mx_agent"]); it is null until the IVR has populated it.

member_verified/intent/category are read from the call disposition written by MX agent voice calls (metadata["disposition"], see disposition_service). SMS/text engagements only ever write flat metadata["member_verified"]/metadata["intent"]/metadata["category"] (no support_team), so those three fall back to the flat keys when no disposition blob exists.

Note: engagement_id is an opaque UUID, safe as a path parameter. Member PHI (name, subscriber ID, language) is returned in the body only.

get/api/v1/engagements/{engagement_id}/context

Request

  • Base URL
    https://api.cloverhealth.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.cloverhealth.com/api/v1/engagements/{engagement_id}/context
  • Auth
    API key in header X-MC2-Signature

Path parameters

engagement_idstring uuid required

Response

OK

engagement_idstring uuid required
first_namestring nullable
last_namestring nullable
subscriber_idstring nullable
preferred_languagestring nullable
member_verifiedboolean nullable
intentstring nullable
master_record_idstring nullable
support_teamstring nullable
categorystring nullable
mx_agentboolean nullable
lh_balanceboolean nullable
member_preferred_buddystring nullable
member_preferred_buddy_worker_sidstring nullable
member_preferred_buddy_matchedstring nullable

Changes