Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

See below:

...

Sample Webhook Payload

v1 (will be deprecated in Sep 2023)

visit.created, visit.updated, visit.ended

...

, visit.note.signed_and_sent, visit.invoice.processed:

Code Block
{
   "version": "1.0",
   "id": "5c34979c-30dc-496c-8cd3-6eb9925862c1",
   "type": "visit.ended",
   "created": 1546950556,
   "account_code": "xxx",
   "data": {
       "id": "28540",
       "member_id": "60610",
       "provider_id": null,
       "start": "1546950546",
       "end": "1546951446",
       "actual_start": "1546950546",
       "actual_end": "1546950555",
       "status": "40",
       "completed_by": "60610"
   }
}

v2 (beta)

visit.created, visit.updated, visit.ended

Code Block
{
   "version": "2.0",
   "id": "5c34979c-30dc-496c-8cd3-6eb9925862c1",
   "type": "visit.ended",
   "created": 1546950556,
   "clinic_code": "xxx",
   "data": {
       "id": "28540",
       "member_id": "60610",
       "provider_id": null,
       "start": 1546950546,
       "end": 1546951446,
       "actual_start": 1546950546,
       "actual_end": 1546950555,
       "status": "cancelled",
       "status_updated_by": "60610"
   }
}

visit.note.signed_and_sent

Code Block
{
   "version": "2.0",
   "id": "5c34979c-30dc-496c-8cd3-6eb9925862c1",
   "type": "visit.note.signed_and_sent",
   "created": 1546950556,
   "clinic_code": "xxx",
   "data": {
       "id": "28540",
       "member_id": "60610",
       "provider_id": null,
       "start": 1546950546,
       "end": 1546951446,
       "actual_start": 1546950546,
       "actual_end": 1546950555,
       "status": "completed",
       "status_updated_by": "60610",
       "note": {
         "id": xxx,
         "status": "signed" // new, signed, draft
       }
   }
}

visit.invoice.processed

Code Block
breakoutModewide
{
   "version": "2.0",
   "id": "5c34979c-30dc-496c-8cd3-6eb9925862c1",
   "type": "visit.invoice.processed",
   "created": 1546950556,
   "clinic_code": "xxx",
   "data": {
       "id": "28540",
       "member_id": "60610",
       "provider_id": null,
       "start": 1546950546,
       "end": 1546951446,
       "actual_start": 1546950546,
       "actual_end": 1546950555,
       "status": "completed",
       "status_updated_by": "60610",
       "invoice": {
         "id": "132",
         "status": "pending", // pending,processing,paid,closed,forgiven,cancelled,failed,refunded
         "amount_due": 2500, // amount in cents [TBD]
         "amount_paid": 1500, // amount in cents [TBD]
         "currency": "USD",
       }
   }
}

...