List webhooks

Lists registered webhook endpoints and the event types each endpoint is subscribed to receive.

Last updated July 4, 2026

GET/v1/webhooks

Webhooks deliver real-time notifications when resources change in vcaremd — appointment confirmations, claim status updates, and patient portal events. Use this endpoint to audit configured endpoints during security reviews or environment promotion.

GET/v1/webhooksAuth required

Lists registered webhook endpoints and subscribed event types.

Name	In	Type	Required	Description
limit	query	integer	No	Results per page. Default 20.
status	query	enum	No	enabled \| disabled

200 OKjson

{
  "data": [{ "id": "wh_4Np8qR2mTx", "status": "enabled" }]
}

Supported event types

Event	Description
patient.created	New patient record persisted
appointment.confirmed	Patient or staff confirmed visit
claim.accepted	Payer accepted the claim
claim.rejected	Claim rejected with reason codes

Example responsejson

{
  "data": [
    {
      "id": "wh_4Np8qR2mTx",
      "url": "https://api.yourapp.com/hooks/vcaremd",
      "enabled_events": ["patient.created", "appointment.confirmed"],
      "status": "enabled"
    }
  ]
}

Verifying signatures

Each webhook includes a Vcaremd-Signature header. Validate it using HMAC SHA-256 with your endpoint secret before processing the payload. Reject requests older than five minutes to mitigate replay attacks.

Was this page helpful?

Your feedback helps us improve our documentation.