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 information. ...
Account Management: Webhooks
Account Management Account Status Event account_status Payload 1{
2 "accountId": "",
3 "active":
4}
Description Push notification event to partner when an account is registered, ...
Direct Messaging: Webhooks
Direct Messaging Inbound Direct Event inbound_direct Payload 1{
2 "accountId": "",
3 "userId": "",
4 "messageId":
5}
Description Push notification event to partner when a direct ...
Document Management: Webhooks
Document Managemen t Import to EHR Event import_to_ehr
Payload 1{
2 "accountId": "",
3 "messageId": ,
4 "userId": "",
5 "patientId": "",
6 "categoryId": "",
7 "date": " "
8}
D...
Faxing: Webhooks
Faxing Inbound Fax Event
inbound_fax
Payload 1{
2 "faxId": ,
3 "accountId": ""
4}
Description
Push notification event to partner when a fax was received by Updox.
...
Patient Management: Webhooks
Patient Managemen t Patient Communication Consent Event patient_communication_consent Payload 1{
2 "practiceId": "",
3 "patientId": "",
4 "action": "",
5 "deliveryMethod": ""
6}
Descr...
Patient Portal: Webhooks
Patient Portal Import Message Event import_message Payload 1{
2 "accountId": "",
3 "userId": "",
4 "messageId": ,
5 "patientId": ""
6}
Description Push notification event to par...
Secure Conversation Management: Webhooks
Secure Conversation Management Secure Conversation Expired Event secure_conversation_expired
Payload 1{
2 "accountId": "",
3 "conversationId": "",
4 "expirationDttm": " "
5}
Description...
Reminders: Webhooks
Reminders Inbound Notification Reply Event inbound_notification_reply Payload 1{
2 "accountId": "",
3 "internalId": "",
4 "reply": ""
5}
Description Push notification event to partn...
Video Chat: Webhooks
Video Management Video Call End Metrics Available Event video_call_end_metrics_available
Payload 1{
2 "accountId": "string",
3 "callId": "string",
4 "availableAfterDatetime": " "
5}
Descr...
Form: Webhooks
Form Management Form Submitted V2 Event form_submitted_v2 Payload 1{
2 "accountId": "",
3 "submittedFormId": "",
4 "submittedAt": " ",
5 "formLibraryDetail": {
6 "formLibraryId": "",
7 ...