Reminders: Webhooks



Reminders

Inbound Notification Reply

Event


 inbound_notification_reply 


Payload

1{
2  "accountId": "",
3  "internalId": "",
4  "reply": ""
5}

Description


Push notification event to partner when there is a reply to an event notification

Payload Summary


  • accountId: the unique identifier of the account

  • internalId: the unique identifier of the event notification

  • reply: the state of event notification


Inbound Reminder Reply

Event

inbound_reminder_reply 

Payload
 
1{
2  "accountId": "",
3  "externalId": "",
4  "reply": ""
5}


Description

Push notification event to partner when a patient replies to an appointment reminder

Payload Summary

  • accountId: the unique identifier of the account

  • externalId: the unique identifier of the appointment the reminder is tied to

  • reply: the patient’s reply to the appointment reminder 



Outbound Reminder Status

Event


outbound_reminder_status

Payload
 
1{
2  "practiceId": "",
3  "reminderId": <long>,
4  "appointmentId": "",
5  "status": ""
6}

Description


Push notification event to partner when a change is detected in the reminder status

Payload Summary


  • practiceId: the unique identifier of the account

  • reminderId: the unique identifier of the reminder

  • appointmentId: the unique identifier of the appointment the reminder is tied to

  • status: the new status of the appointment reminder