Hero Health Developer Portal

Webhook Events

Hero Health Webhooks API

HeroHealth Webhooks 1.0.0

Servers

https://webhooks-manager.htech.app/httpsproduction
Production
https://webhooks-manager.staging.htech.app/httpsstaging
Staging

Operations

SEND appointment.confirmed
An appointment has been confirmed
Operation IDappointment.confirmed
Available only on servers:
- production
- staging
Accepts the following message:
application/json
Message IDsubscribe.message
object
object
required
string
Allowed values:
"Appointment"
id
required
string
practice_group_id
required
string
event
required
string
Allowed values:
"appointment.confirmed"
Additional properties are allowed.
Examples
{ "object": "Appointment", "id": "string", "practice_group_id": "string", "event": "appointment.confirmed" }

This example has been generated automatically.
SEND appointment.rescheduled
An appointment has been rescheduled
Operation IDappointment.rescheduled
Available only on servers:
- production
- staging
Accepts the following message:
application/json
Message IDsubscribe.message
object
object
required
string
Allowed values:
"Appointment"
id
required
string
practice_group_id
required
string
event
required
string
Allowed values:
"appointment.rescheduled"
Additional properties are allowed.
Examples
{ "object": "Appointment", "id": "string", "practice_group_id": "string", "event": "appointment.rescheduled" }

This example has been generated automatically.
SEND appointment.cancelled
An appointment has been cancelled
Operation IDappointment.cancelled
Available only on servers:
- production
- staging
Accepts the following message:
application/json
Message IDsubscribe.message
object
object
required
string
Allowed values:
"Appointment"
id
required
string
practice_group_id
required
string
event
required
string
Allowed values:
"appointment.cancelled"
Additional properties are allowed.
Examples
{ "object": "Appointment", "id": "string", "practice_group_id": "string", "event": "appointment.cancelled" }

This example has been generated automatically.
SEND prescription.issued
A prescription has been issued
Operation IDprescription.issued
Available only on servers:
- production
- staging
Accepts the following message:
application/json
Message IDsubscribe.message
object
object
required
string
Allowed values:
"Prescription"
id
required
string
practice_group_id
required
string
event
required
string
Allowed values:
"prescription.issued"
Additional properties are allowed.
Examples
{ "object": "Prescription", "id": "string", "practice_group_id": "string", "event": "prescription.issued" }

This example has been generated automatically.
SEND patient.medical-record-updated
A patient medical record has been updated
Operation IDpatient.medical-record-updated
Available only on servers:
- production
- staging
Accepts the following message:
application/json
Message IDsubscribe.message
object
object
required
string
Allowed values:
"Patient"
id
required
string
practice_group_id
required
string
event
required
string
Allowed values:
"patient.medical-record-updated"
Additional properties are allowed.
Examples
{ "object": "Patient", "id": "string", "practice_group_id": "string", "event": "patient.medical-record-updated" }

This example has been generated automatically.
SEND patient.added-to-sequence
A patient has been added to a sequence
Operation IDpatient.added-to-sequence
Available only on servers:
- production
- staging
Accepts the following message:
application/json
Message IDsubscribe.message
object
object
required
string
Allowed values:
"Patient"
id
required
string
practice_group_id
required
string
event
required
string
Allowed values:
"patient.added-to-sequence"
Additional properties are allowed.
Examples
{ "object": "Patient", "id": "string", "practice_group_id": "string", "event": "patient.added-to-sequence" }

This example has been generated automatically.

Servers

Operations

SEND appointment.confirmed

Examples

This example has been generated automatically.

SEND appointment.rescheduled

Examples

This example has been generated automatically.

SEND appointment.cancelled

Examples

This example has been generated automatically.

SEND prescription.issued

Examples

This example has been generated automatically.

SEND patient.medical-record-updated

Examples

This example has been generated automatically.

SEND patient.added-to-sequence

Examples

This example has been generated automatically.