Skip to content
API Docs/
/appointment.cancelled

HeroHealth Webhooks 1.0.0

Download AsyncAPI description
asyncapi.json
asyncapi.yaml
Servers
production
webhooks-manager.htech.app
More details
staging
webhooks-manager.staging.htech.app
More details
Channel

appointment.confirmed

name: appointment.confirmed

Messages

Accepts the following message:

Payloadapplication/json

objectstringrequired
Value"Appointment"
idstringrequired
practice_group_idstringrequired
eventstringrequired
Value"appointment.confirmed"
Payload
{
  "object": "Appointment",
  "id": "string",
  "practice_group_id": "string",
  "event": "appointment.confirmed"
}

Send

Send

appointment.confirmed

An appointment has been confirmed

Messages

Channel

appointment.rescheduled

name: appointment.rescheduled

Messages

Accepts the following message:

Payloadapplication/json

objectstringrequired
Value"Appointment"
idstringrequired
practice_group_idstringrequired
eventstringrequired
Value"appointment.rescheduled"
Payload
{
  "object": "Appointment",
  "id": "string",
  "practice_group_id": "string",
  "event": "appointment.rescheduled"
}

Send

Send

appointment.rescheduled

An appointment has been rescheduled

Messages

Channel

appointment.cancelled

name: appointment.cancelled

Messages

Accepts the following message:

Payloadapplication/json

objectstringrequired
Value"Appointment"
idstringrequired
practice_group_idstringrequired
eventstringrequired
Value"appointment.cancelled"
Payload
{
  "object": "Appointment",
  "id": "string",
  "practice_group_id": "string",
  "event": "appointment.cancelled"
}

Send

Send

appointment.cancelled

An appointment has been cancelled

Messages

Channel

form-submission.created

name: form-submission.created

Messages

Accepts the following message:

Payloadapplication/json

objectstringrequired
Value"FormSubmission"
idstringrequired
practice_group_idstringrequired
eventstringrequired
Value"form-submission.created"
Payload
{
  "object": "FormSubmission",
  "id": "string",
  "practice_group_id": "string",
  "event": "form-submission.created"
}

Send

Send

form-submission.created

A form submission has been created

Messages

Channel

prescription.issued

name: prescription.issued

Messages

Accepts the following message:

Payloadapplication/json

objectstringrequired
Value"Prescription"
idstringrequired
practice_group_idstringrequired
eventstringrequired
Value"prescription.issued"
Payload
{
  "object": "Prescription",
  "id": "string",
  "practice_group_id": "string",
  "event": "prescription.issued"
}

Send

Send

prescription.issued

A prescription has been issued

Messages

Channel

patient.added-to-sequence

name: patient.added-to-sequence

Messages

Accepts the following message:

Payloadapplication/json

objectstringrequired
Value"Patient"
idstringrequired
practice_group_idstringrequired
eventstringrequired
Value"patient.added-to-sequence"
Payload
{
  "object": "Patient",
  "id": "string",
  "practice_group_id": "string",
  "event": "patient.added-to-sequence"
}

Send

Send

patient.added-to-sequence

A patient has been added to a sequence

Messages

Channel

write-to-record.succeeded

name: write-to-record.succeeded

Messages

Accepts the following message:

Payloadapplication/json

objectstringrequired
Value"WriteToRecordEntry"
idstringrequired
practice_group_idstringrequired
eventstringrequired
Value"write-to-record.succeeded"
Payload
{
  "object": "WriteToRecordEntry",
  "id": "string",
  "practice_group_id": "string",
  "event": "write-to-record.succeeded"
}

Send

Send

write-to-record.succeeded

A WriteToRecord job finished successfully

Messages

Channel

write-to-record.failed

name: write-to-record.failed

Messages

Accepts the following message:

Payloadapplication/json

objectstringrequired
Value"WriteToRecordEntry"
idstringrequired
practice_group_idstringrequired
eventstringrequired
Value"write-to-record.failed"
Payload
{
  "object": "WriteToRecordEntry",
  "id": "string",
  "practice_group_id": "string",
  "event": "write-to-record.failed"
}

Send

Send

write-to-record.failed

A WriteToRecord job failed permanently

Messages

Channel

ehr.health_status.healthy

name: ehr.health_status.healthy

Messages

Accepts the following message:

Payloadapplication/json

objectstringrequired
Value"EhrHealthStatus"
idstringrequired
practice_group_idstringrequired
eventstringrequired
Value"ehr.health_status.healthy"
Payload
{
  "object": "EhrHealthStatus",
  "id": "string",
  "practice_group_id": "string",
  "event": "ehr.health_status.healthy"
}

Send

Send

ehr.health_status.healthy

The EHR connection for a practice group has become healthy

Messages

Channel

ehr.health_status.unhealthy

name: ehr.health_status.unhealthy

Messages

Accepts the following message:

Payloadapplication/json

objectstringrequired
Value"EhrHealthStatus"
idstringrequired
practice_group_idstringrequired
eventstringrequired
Value"ehr.health_status.unhealthy"
Payload
{
  "object": "EhrHealthStatus",
  "id": "string",
  "practice_group_id": "string",
  "event": "ehr.health_status.unhealthy"
}

Send

Send

ehr.health_status.unhealthy

The EHR connection for a practice group has become unhealthy

Messages