Send to Alleviate

POST patient/lead data to the Alleviate API. You do not need to provide a patient_id - the endpoint fetches it automatically from Realtime by looking up t-e patient by email and instance.

POST /api/alleviate/send
How it works

The endpoint runs a 3-step orchestration. Each step is handled automatically; you only send the payload once.

Step 1: Get API key from Activepieces

The API sends a POST request to the Activepieces webhook (same as Realtime ERG) with an empty body. The response contains a JWT key that is used to authenticate with the Realtime API in the next step.

POST cloud.activepieces.com/api/v1/webhooks/.../sync

Step 2: Lookup patient in Realtime

Using the key from Step 1, the API calls the Realtime subjects endpoint with your instance_name and email. It extracts the subjectId from the first matching record. If no patient is found, the request fails with a 404.

GET soms-api-us.realtime-host01.com/api/v2/subjects?instanceName=...&email=...

Step 3: POST to Alleviate

The API builds the final payload with form_name, phone, name, patient_id (subjectId from Step 2), and email. It sends this to the Alleviate API with the X-API-Key header. The Alleviate response is returned to you.

POST search.alleviatehealth.care/participant-by-form-name?source=patients_vip

{
  "form_name": "vip_tlc_bunionectomy_ect",
  "phone": "555-123-4567",
  "name": "John Doe",
  "patient_id": 139712,
  "email": "john.doe@example.com"
}
Required fields

All fields are required. instance_name (or site_name) is the Realtime instance used for the patient lookup in Step 2.

  • form_name - Alleviate form identifier (e.g. vip_tlc_bunionectomy_ect)
  • phone - Patient phone number
  • name - Full patient name
  • email - Patient email (used for Realtime lookup)
  • instance_name - Realtime instance/site (e.g. ect)
Example payload
{
  "form_name": "vip_tlc_bunionectomy_ect",
  "phone": "555-123-4567",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "instance_name": "ect"
}
← Back to Alleviate