Menu
Invitation Not Delivered
ENDPOINT: POST /webhook/user-enrollment
In the event that an SMS invite is not delivered to the patient, RxWare will send a callback to the partner system with information about this event.
| Field | Description | Format | Example | Required |
|---|---|---|---|---|
event.message | String, 100 max | Not delivered invite SMS. | ✅ 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.data.key | String, 100 max | delivered | ✅ Yes | |
event.data.value | Bool | true/false | ✅ 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.InvitationDelivery | ✅ Yes |
Sample Request
{
"event": {
"message": "Not delivered invite SMS.",
"supportProgramId": "SupportProgramId",
"sendDate": "2023-02-28T13:27:46.000Z",
"status": "success",
"data": {
"key": "delivered",
"value": false
},
"patient": {
"id": "ha122345",
"phoneNumber": "+38099999999",
"externalIds": [
{
"source": "partner",
"sourceId": "Id_of_patient_in_partner_system"
}
]
}
},
"sourceName": "helparound",
"eventName": "HelpAround.Patient.InvitationDelivery"
}