Skip to main content
PATCH
Update a webhook
Safety
  • Writes data: Yes. Changes the fields you send. headers replaces every configured header.
  • Safe to retry: Yes. Sending the same change again leaves the webhook the same.
  • Contacts an outside system: None
  • Dry run: Not available.
Rolling out: this endpoint is on staging first and not yet on api.healos.ai.
Pause deliveries with { "active": false } and resume with true. A new url is checked the same way as on create. Webhooks belong to the user who created the API key and receive that user’s note and document events, the same as on the dashboard’s Webhooks page. A webhook of another user, in your organization or any other, is a 404. Guide: Webhooks. Errors: Error catalog.

Authorizations

X-API-Key
string
header
required

API key obtained from /api/v1/ext-api-keys

Path Parameters

webhookId
string
required

Webhook identifier, from GET /webhooks.

Example:

"3f2b8c1e-0000-4000-8000-000000000001"

Body

application/json
name
string
Required string length: 1 - 200
Example:

"EHR sync"

url
string<uri>

Your HTTPS endpoint. It must resolve to a public host: loopback, private, link-local and cloud-metadata addresses are rejected.

Maximum string length: 2048
Example:

"https://hooks.example.com/healos"

event_type
enum<string>

The event this webhook receives. One event per webhook.

Available options:
NOTE_CREATED,
NOTE_REGENERATED,
NOTE_UPDATED,
DOCUMENT_STATUS_CHANGED
Example:

"NOTE_CREATED"

format
enum<string>

How the payload is encoded. Default JSON.

Available options:
JSON,
XML,
Form Data
Example:

"JSON"

description
string | null
Maximum string length: 1000
Example:

"Pushes new notes to our EHR bridge"

headers
object

Replaces every configured header. Send {} to remove them all; leave it out to keep them.

Example:
active
boolean

false pauses deliveries without deleting the webhook.

Response

The updated webhook

data
object
required