Articles
Overview: Webhooks
What Are Webhooks? Webhook is a way for a user of a system to tap into the workflow and listen for specific events. When an event of a subscribed webhook occurs, the system will send your assigned listener (the “hook”) the event inf...
Account Management: Webhooks
Account Management Account Status Event account_status Payload 1{
2 "accountId": "",
3 "active": <boolean>
4}
Description Push notificat...
Direct Messaging: Webhooks
Direct Messaging Inbound Direct Event inbound_direct Payload 1{
2 "accountId": "",
3 "userId": "",
4 "messageId": <long>
5}
...
Document Management: Webhooks
Document Managemen t Import to EHR Event import_to_ehr
Payload 1{
2 "accountId": "",
3 "messageId": <long>,
4 "userId": "",
5 "...
Faxing: Webhooks
Faxing Inbound Fax Event
inbound_fax
Payload 1{
2 "faxId": <long>,
3 "accountId": ""
4}
Description
Push notification event to p...
Patient Management: Webhooks
Patient Managemen t Patient Communication Consent Event patient_communication_consent Payload 1{
2 "practiceId": "",
3 "patientId": "",
4 "ac...
Patient Portal: Webhooks
Patient Portal Import Message Event import_message Payload 1{
2 "accountId": "",
3 "userId": "",
4 "messageId": <long>,
5 "p...
Secure Conversation Management: Webhooks
Secure Conversation Management Secure Conversation Expired Event secure_conversation_expired
Payload 1{
2 "accountId": "",
3 "conversationId": "",
4 &q...
Reminders: Webhooks
Reminders Inbound Notification Reply Event inbound_notification_reply Payload 1{
2 "accountId": "",
3 "internalId": "",
4 "reply": "&...