Opt-Out Patient Callback

Home » RxWare Developer Site » Webhooks » Opt-Out Patient Callback

ENDPOINT: POST /webhook/user-action

This request from RxWare to the Partner will be triggered at the moment when the patient replies to the program phone number with the text “STOP”, which means that we will stop sending the messages to this patient and we need to let you know about this opt-out.

				
					{
  "event": {
    "message": "patient replied STOP",
    "supportProgramId": "ec70c6f7-5646-461c-94cc-1a87b6f7a08e",
    "sendDate": "2022-01-01T01:01:01+00:00",
    "status": "success",
    "data": {
      "key": "opt-in",
      "value": false
    },
    "patient": {
      "id": "ha1234567890987",
      "phoneNumber": "+12099999999",
      "externalIds": [
        {
          "source": "partner",
          "sourceId": "Id_of_patient_in_partner_system"
        }
      ]
    }
  },
  "sourceName": "helparound",
  "eventType": "sms",
  "eventName": "HelpAround.Patient.Consent"
}

NEXT: ➡️ Opt-In Patient Callback