Introduction
Trigger is a message to one particular person which can be set up for a client and sent on demand as API call. The trigger works only for known patients/employees, who are already registered in Dialog Health database. Triggers can be used in different ways.
Use a trigger as a confirmation that phone number you gave in clinic is actually your phone number
Somebody is doing an online form (outside our system) and our client needs to trigger a message with their unique ID (Misc1). Once the form is filled in, their API calls to DH with the patient’s ID, we send text with this ID (Misc1) to the patient.
“NotificationTriggerID” and “patientID” are needed to run the trigger message.
Access
HTTP Basic Authentication basic
Endpoints
http://[dialoghealth-server]//dh-integration/rest/
Trigger
Trigger notification
POST /triggernotification/{console-code}
Parameters
Path Parameter
{console-code} | A unique set of letters and numbers automatically assigned to each console upon creating | X | SIDJUL8079 |
Body Parameter
TriggernotificationRequest | TriggernotificationRequest | X | - |
Return Type
TriggernotificationResponse
Content Type
application/json
Responses
200 | - | TriggernotificationResponse |
400 | - | TriggernotificationResponse |
Samples
Sample curl command to send request
1$ curl --location --request POST 'https://{dialoghealth-server}/dhintegration/rest/triggernotification/WEBMAG6745' \
2--header 'Content-Type: application/json' \
3--header 'Accept: application/json' \
4--header 'Authorization: Basic {credentials}' \
5--data-raw '{
6 "notificationTriggerId": "VF4G8R7O",
7 "patientId": "732d85650117415aa0b4d3858c937916"
8}'
Sample request body (json)
1{
2 "notificationTriggerId": "VF4G8R7O",
3 "patientId": "732d85650117415aa0b4d3858c937916"
4}
Sample response body (json)
1{
2 "message": "Patient requires optin"
3}
Models
TriggernotificationRequest
notificationTriggerId | X | String | Unique identifier of notification trigger | - |
patientId | X | String | Unique identifier of a patient | - |
TriggernotificationResponse
message | String | API response message | - |