UserAction – Echo Update

Home » RxWare Developer Site » Webhooks » UserAction – Echo Update

ENDPOINT: POST /webhook/user-enrollment

Once the patient’s dosage is updated on the mobile web, RxWare will send the callback to the partner.

Field	Description	Format	Example	Required
`event.message`		String, 100 max	patient dosing update	✅ Yes
`event.supportProgramId`		String, 100 max	b1mTs000g35ha2pt	✅ Yes
`event.sendDate`	Send date in UTC	Datetime {yyyy-mm-ddT hh:mm:ss.sssZ}	2021-08-23T06:25:00+00:00	✅ Yes
`event.status`		String, 100 max	success	✅ Yes
`event.additionalData`	Can take in multiple objects	Array		No
`event.additionalData.[].key`		String, 100 max	completeEchoTest	No
`event.additionalData.[].value`		String, 100 max	No	No
`event.data.key`		String, 100 max	userAction	✅ Yes
`event.data.value`		String, 100 max	echoStatusUpdated	✅ Yes
`event.patientId`	RxWare patient ID	String, 100 max	ha61b9db97350d1	✅ Yes
`event.patient.phoneNumber`	Patient's mobile phone number	E.164 format	+12565551212	✅ Yes
`event.patient.externalIds`	Can take in multiple objects	Array		✅ Yes
`event.patient.externalIds.source`		String, max 100	Partner	✅ Yes
`event.patient.externalIds.sourceId`	Partner patient Id(s)	String, max 100	Id_of_patient_in_partner_system	✅ Yes
`event.sourceName`		String, max 100	helparound	✅ Yes
`event.eventName`		String, max 100	HelpAround.Patient.UserAction	✅ Yes

Sample Request

				
					{
  "event": {
    "additionalData": [
      {
        "key": "completeEchoTest",
        "value": "No"
      },
      {
        "key": "haveScheduledEchoTest",
        "value": "Yes"
      },
      {
        "key": "echoDate",
        "value": "2023-03-01T00:00:00.000Z"
      },
      {
        "key": "locationTitle",
        "value": "testEchoFacility"
      },
      {
        "key": "locationId",
        "value": "testEchoFacility"
      }
    ],
    "data": {
      "key": "userAction",
      "value": "echoStatusUpdated"
    },
    "message": "patient echo update",
    "patient": {
      "externalIds": [
        {
          "source": "partner",
          "sourceId": "Id_of_patient_in_partner_system"
        }
      ],
      "id": "ha1234567890987",
      "phoneNumber": "+12099999999"
    },
    "sendDate": "2023-02-28T11:07:47.000Z",
    "status": "success",
    "supportProgramId": "SupportProgramId"
  },
  "eventName": "HelpAround.Patient.UserAction",
  "sourceName": "helparound"
}

NEXT: ➡️ User Action – Infusion Update