Update_Backend

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hint-health/main/json-schema/hint-health-partner-backends-controller-update-body-schema.json",
  "title": "Update_Backend",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/hint-health-backend-api-openapi.yml#/components/schemas/Partner.BackendsController.update_body",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Human-readable label for the backend."
    },
    "auth_type": {
      "type": "string",
      "description": "One of `manual`, `automatic_redirect`, `automatic_headless`."
    },
    "activation_type": {
      "type": "string",
      "description": "One of `instant`, `partner_activate`, `practice_activate`."
    },
    "redirect_url": {
      "type": "string",
      "description": "OAuth redirect URL invoked after `authorization_code` issuance."
    },
    "localhost_redirect_url": {
      "type": "string",
      "description": "HTTP localhost URL used in place of `redirect_url` when the requesting browser session has localhost mode enabled. Sandbox partners only."
    },
    "localhost_webhook_url": {
      "type": "string",
      "description": "HTTP localhost URL the browser proxies this backend's webhook deliveries to when localhost mode is enabled. Sandbox partners only."
    },
    "webhooks_disabled": {
      "type": "boolean",
      "description": "Disables webhook delivery for this backend's endpoints."
    },
    "webhooks_paused": {
      "type": "boolean",
      "description": "Pauses webhook delivery for this backend's endpoints."
    },
    "unmute_self_webhooks": {
      "type": "boolean",
      "description": "Delivers webhooks for events triggered by this backend's own requests."
    },
    "max_requests_per_minute": {
      "type": "integer",
      "format": "int32",
      "description": "Webhook delivery rate ceiling for this backend."
    },
    "listened_events": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Event types delivered to this backend's endpoints."
    },
    "webhooks_signature_api_key": {
      "type": "object",
      "description": "The partner-owned api key whose secret signs this backend's webhooks. Pass `{ \"id\": \"<api key id>\" }`."
    },
    "api_credentials_configuration": {
      "type": "object",
      "description": "The backend's API-publishing configuration. Accepts `spec_url`, `docs_url`, `issuance_mode` (`push`/`pull`), `exchange_url`, and `call_path` (`proxy`/`direct`)."
    }
  }
}