API Reference
/
Webhooks
/
Delete a Webhook

Hero Health Public API (1.0.0)

Download OpenAPI description
Download API docs
Languages
Servers
Mock server
https://developer.herohealth.net/_mock/apis/public-api/openapi/
Staging
https://api.staging.htech.app/
Production
https://api.herohealth.net/

Practice Group

Operations

Admin

Operations

Booking

Operations

Links

Operations

Utilities

Operations

Messages

Operations

Booking - HCA

Operations

Care Navigation

Operations

Form

Operations

Form Response

Operations

Invoicing

Operations

Patients

Operations

Prescription

Operations

Subscriptions

Operations

Task

Operations

Webhooks

Operations

Create a Webhook

Request

Creates a webhook for the authenticated practice group.

Bodyapplication/jsonrequired
descriptionstring
event_typestringrequired
Enum"appointment.confirmed""appointment.cancelled""appointment.rescheduled""prescription.issued""patient.medical-record-updated""patient.added-to-sequence"
signing_keystring
urlstring(uri)required
headersobject
curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/webhooks \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "description": "string",
    "event_type": "appointment.confirmed",
    "signing_key": "string",
    "url": "http://example.com",
    "headers": {
      "property1": "string",
      "property2": "string"
    }
  }'

Responses

Ok

Bodyapplication/json
idstringrequired
event_typestringrequired
urlstringrequired
signing_keystring
headersobject
created_atstringrequired
updated_atstringrequired
Response
application/json
{
  "id": "string",
  "event_type": "string",
  "url": "string",
  "signing_key": "string",
  "headers": {
    "property1": "string",
    "property2": "string"
  },
  "created_at": "string",
  "updated_at": "string"
}

List Webhooks

Request

Retrieves a list of webhooks for the authenticated practice group.

Query
event_typestring
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/webhooks?event_type=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
dataArray of objectsrequired
data[].​idstringrequired
data[].​event_typestringrequired
data[].​urlstringrequired
data[].​signing_keystring
data[].​headersobject
data[].​created_atstringrequired
data[].​updated_atstringrequired
countnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 0
}

Delete a Webhook

Request

Deletes a webhook by its ID.

Path
idstringrequired
curl -i -X DELETE \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/webhooks/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

No Content

Response
No content

List Webhook Executions

Request

Retrieves a list of executions for a specific webhook.

Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/webhooks/{id}/executions' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
dataArray of objectsrequired
data[].​execution_idstring(uuid)required
data[].​webhook_idstring(uuid)required
data[].​event_typestringrequired
Enum"appointment.confirmed""appointment.cancelled""appointment.rescheduled""prescription.issued""patient.medical-record-updated""patient.added-to-sequence"
data[].​statusstringrequired
Enum"success""failed"
data[].​request_bodystringrequired
data[].​response_bodystringrequired
data[].​response_statusnumberrequired
data[].​created_atstringrequired
data[].​updated_atstringrequired
countnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 0
}

Prescriptions

Operations