> ## Documentation Index
> Fetch the complete documentation index at: https://docs.healos.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a webhook

> Changes the fields you send. `active: false` pauses deliveries. `headers` replaces every configured header. A new `url` is checked like on create. Another user's webhook is a 404. Requires the webhooks:write scope.

| Requirement | Detail |
| - | - |
| **Scope** | `webhooks:write` |
| **Rate limit** | About 60 requests per minute per API key (shared by all endpoints; approximate) |
| **Cost** | Free |

> [!NOTE]
>
> **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.

> [!NOTE]
>
> 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](https://docs.healos.ai/webhooks.md). Errors: [Error catalog](https://docs.healos.ai/errors.md).


## OpenAPI

````yaml openapi/ext-api-v1.json PATCH /webhooks/{webhookId}
openapi: 3.0.0
info:
  title: Healos External API
  version: 1.0.0
  description: >-
    External API for managing patients, documents, and appointments, listing
    providers and note templates, pulling clinical notes (with transcript and
    patient context), running insurance eligibility checks, browsing the EHR
    action catalog, reading AI Receptionist calls (summary, transcript,
    extracted details and recording), managing the AI Receptionist inbox tasks,
    and registering webhooks for note and document events.
servers:
  - url: https://api.healos.ai/ext-api/v1
    description: Production
  - url: http://localhost:8787/ext-api/v1
    description: Local development
security:
  - ApiKeyAuth: []
paths:
  /webhooks/{webhookId}:
    patch:
      tags:
        - Webhooks
      summary: Update a webhook
      description: >-
        Changes the fields you send. `active: false` pauses deliveries.
        `headers` replaces every configured header. A new `url` is checked like
        on create. Another user's webhook is a 404. Requires the webhooks:write
        scope.
      parameters:
        - schema:
            type: string
            description: Webhook identifier, from GET /webhooks.
            example: 3f2b8c1e-0000-4000-8000-000000000001
          required: true
          name: webhookId
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookUpdate'
      responses:
        '200':
          description: The updated webhook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookResponse'
        '400':
          description: >-
            Validation error: an unknown event type or format, a URL that is not
            HTTPS on a public host, a reserved or malformed header, or an
            unknown field
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Insufficient scope (needs webhooks:write)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Webhook not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitError'
components:
  schemas:
    WebhookUpdate:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 200
          example: EHR sync
        url:
          type: string
          maxLength: 2048
          format: uri
          description: >-
            Your HTTPS endpoint. It must resolve to a public host: loopback,
            private, link-local and cloud-metadata addresses are rejected.
          example: https://hooks.example.com/healos
        event_type:
          type: string
          enum:
            - NOTE_CREATED
            - NOTE_REGENERATED
            - NOTE_UPDATED
            - DOCUMENT_STATUS_CHANGED
          description: The event this webhook receives. One event per webhook.
          example: NOTE_CREATED
        format:
          type: string
          enum:
            - JSON
            - XML
            - Form Data
          description: How the payload is encoded. Default `JSON`.
          example: JSON
        description:
          type: string
          nullable: true
          maxLength: 1000
          example: Pushes new notes to our EHR bridge
        headers:
          type: object
          additionalProperties:
            type: string
          description: >-
            Replaces every configured header. Send `{}` to remove them all;
            leave it out to keep them.
          example:
            Authorization: Bearer your-shared-secret
        active:
          type: boolean
          description: '`false` pauses deliveries without deleting the webhook.'
      additionalProperties: false
    WebhookResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Webhook'
      required:
        - data
    ValidationError:
      type: object
      properties:
        error:
          type: string
        details:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      required:
        - error
    Error:
      type: object
      properties:
        error:
          type: string
      required:
        - error
    RateLimitError:
      type: object
      properties:
        error:
          type: string
          example: Rate limit exceeded. Please retry after the window resets.
        code:
          type: string
          enum:
            - daily_cap_reached
          description: >-
            Set when the organization reached its daily cap for this paid
            operation (not on a per-minute limit).
        reset_at:
          type: string
          format: date-time
          description: 'With `code`: when the daily cap resets (next 00:00 UTC).'
          example: '2026-10-28T00:00:00.000Z'
      required:
        - error
    Webhook:
      type: object
      properties:
        id:
          type: string
          example: 3f2b8c1e-0000-4000-8000-000000000001
        name:
          type: string
        url:
          type: string
        event_type:
          type: string
          example: NOTE_CREATED
        format:
          type: string
          example: JSON
        description:
          type: string
          nullable: true
        header_names:
          type: array
          items:
            type: string
          description: >-
            The names of the configured headers. Their values are never
            returned.
          example:
            - Authorization
        active:
          type: boolean
        created_at:
          type: string
          example: '2026-11-03T14:00:00.000Z'
      required:
        - id
        - name
        - url
        - event_type
        - format
        - description
        - header_names
        - active
        - created_at
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key obtained from /api/v1/ext-api-keys

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.