Enrollment Consent Only Flow

Home » RxWare Developer Site » Webhooks » Enrollment Consent Only Flow

ENDPOINT: POST /webhook/user-enrollment

After a patient or caregiver completes a mobile enrollment flow, RxWare sends all of the information gathered to the partner via POST request.

Media data: expected media files (e.g. insurance card, signature) can be fetched via IDs that are provided in this Enrollment API Post.

See the Get Patient’s Media request.

Field	Description	Format	Example	Required
`event.message`		String, 100 max	Patient complete enrollment	No
`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
`event.patient.id`	RxWare patient ID	String, 100 max	ha61b9db97350d1	✅ Yes
`event.patient.phoneNumber`	Patient's mobile phone number	E.164 format	+12565551212	✅ Yes
`event.patient.firstName`		String, max 100, ASCII 128	John	✅ Yes
`event.patient.lastName`		String, max 100, ASCII 128		No
`event.patient.externalIds`	Can take in multiple objects	Array		No
`event.patient.externalIds.source`		String, max 100	Partner	No
`event.patient.externalIds.sourceId`	Partner patient Id(s)	String, max 100	4aadb997-e9fd-3909-a2f0-833b821544bd	No
`event.patient.mediaIds`	Can take in multiple objects	Array		No
`event.patient.mediaIds.mediaType`		String, max 100	insurance, "consent"	No
`event.patient.mediaIds.mediaId`	identifier of media file	String, max 100	6253d25de50dcab75b08f0b2	No
`event.patient.mediaIds.fileType`		String, max 100	jpg, "jpeg", "gif", "png", "pdf".	No
`event.sourceName`		String, max 100	helparound	No
`event.eventName`		String, max 100	RxWare .Patient.CompleteEnrollment	✅ Yes

Sample Request

				
					{
  "event": {
    "supportProgramId": "78ef982b-00ea-39c2-a875-f549c40e92ad",
    "message": "Patient complete enrollment.",
    "patient": {
      "externalIds": [
        {
          "source": "partner",
          "sourceId": "Id_of_patient_in_partner_system"
        }
      ],
      "firstName": "firstNameTest",
      "id": "ha12345",
      "lastName": "lastNameTest",
      "mediaIds": [
        {
          "fileType": "pdf",
          "mediaId": "6253d25de50dcab75b08f0b2",
          "mediaType": "consent"
        }
      ],
      "phoneNumber": "+12099999999"
    },
    "sendDate": "2023-03-02T11:31:46.000Z",
    "status": "success"
  },
  "eventName": "HelpAround.Patient.CompleteEnrollment",
  "sourceName": "helparound"
}

NEXT: ➡️ Invitation Delivered