Skip to content
API reference/
API Reference
/
/
Create a Webhook

Create a Webhook

Request

Create a webhook subscription for the authenticated practice group. Hero will send an HTTP POST request to the specified URL whenever the subscribed event occurs.

Available events: appointment.confirmed, appointment.cancelled, appointment.rescheduled, prescription.issued, patient.added-to-sequence, write-to-record.succeeded, write-to-record.failed.

Optionally provide a signing_key to enable HMAC-SHA256 signature verification on incoming webhook requests. See the webhook security documentation for verification examples.

Security
apiKeyAuth and practiceGroupId
Bodyapplication/jsonrequired
descriptionstring
event_typestringrequired
Enum:"appointment.confirmed""appointment.cancelled""appointment.rescheduled""form-submission.created""prescription.issued""patient.medical-record-updated""patient.added-to-sequence""write-to-record.succeeded""write-to-record.failed"
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": "Notify our system when appointments are confirmed",
    "event_type": "appointment.confirmed",
    "signing_key": "whsec_your-secret-key-here",
    "url": "https://example.com/webhooks/hero"
  }'

Responses

Ok

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