Create webhook
Registers a new HTTPS endpoint to receive event notifications. Returns the endpoint secret required for signature verification.
Last updated
POST
/v1/webhooksRegister endpoints that can receive POST requests from vcaremd infrastructure. URLs must be publicly reachable over HTTPS with a valid TLS certificate. Localhost and IP literals are rejected in production.
POST
/v1/webhooksAuth requiredCreates a webhook endpoint and returns the signing secret.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| url | body | string | Yes | HTTPS URL that accepts POST requests. |
| enabled_events | body | array | Yes | One or more event type strings. |
| description | body | string | No | Human-readable label for your dashboard. |
Requestjson
{
"url": "https://api.yourapp.com/hooks/vcaremd",
"enabled_events": ["patient.created", "claim.accepted"],
"description": "Production billing worker"
}Responsejson
{
"id": "wh_4Np8qR2mTx",
"secret": "whsec_9Kp2mN8qRt1vW...",
"status": "enabled"
}Register endpoints with an HTTPS URL that returns 200 within 10 seconds for the initial handshake probe.
Design webhook handlers to be idempotent — the same event ID may be delivered more than once during retries.
Was this page helpful?
Your feedback helps us improve our documentation.