anpheros-com Webhooks API

openapi: 3.2.0
info:
  title: Anpheros Platform Webhooks API
  description: 'Health-data platform for developers, clinics and AI agents.


    * **FHIR R4** at `/fhir/R4` — the strict interface (search, history, transactions, Provenance).

    * **REST v1** at `/v1` — the simplified interface for app developers, same data, same ids.

    * **Admin** at `/admin` — organizations, projects, applications and API keys (Firebase user token).

    * **OAuth 2.1 / SMART** at `/oauth/*` — patient consent with PKCE; `/me/*` — the patient''s own connections.


    Authenticate with an API key (`Authorization: Bearer sk_test_…` / `sk_live_…`) or an OAuth access token (`at_…`).

    Every response carries `Anpheros-Request-Id`; POSTs accept `Idempotency-Key`.'
  version: 0.3.0
servers:
- url: https://platform.anpheros.com
  description: Sandbox and production share this address; the key decides the data plane.
tags:
- name: Webhooks
paths:
  /v1/webhooks:
    post:
      tags:
      - Webhooks
      summary: Register a webhook endpoint (the secret is shown once)
      operationId: create_endpoint_v1_webhooks_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Api-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: X-Anpheros-Acting-As
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-Acting-As
      - name: X-Anpheros-On-Behalf-Of
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-On-Behalf-Of
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointIn'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
        '403':
          description: The credential's scope or the patient's consent does not allow this.
        '429':
          description: Rate limit exceeded; wait `Retry-After` seconds.
      security:
      - bearer: []
      - apiKey: []
      - oauth2:
        - patient/*.rs
        - patient/Observation.rs
        - patient/Observation.rs?category=laboratory
        - patient/Condition.rs
        - patient/MedicationStatement.rs
        - patient/DocumentReference.rs
        - patient/AllergyIntolerance.rs
        - offline_access
        - openid
        - fhirUser
        - anpheros/patterns
    get:
      tags:
      - Webhooks
      summary: List webhook endpoints
      operationId: list_endpoints_v1_webhooks_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Api-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: X-Anpheros-Acting-As
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-Acting-As
      - name: X-Anpheros-On-Behalf-Of
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-On-Behalf-Of
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
        '403':
          description: The credential's scope or the patient's consent does not allow this.
        '429':
          description: Rate limit exceeded; wait `Retry-After` seconds.
      security:
      - bearer: []
      - apiKey: []
      - oauth2:
        - patient/*.rs
        - patient/Observation.rs
        - patient/Observation.rs?category=laboratory
        - patient/Condition.rs
        - patient/MedicationStatement.rs
        - patient/DocumentReference.rs
        - patient/AllergyIntolerance.rs
        - offline_access
        - openid
        - fhirUser
        - anpheros/patterns
  /v1/webhooks/event-types:
    get:
      tags:
      - Webhooks
      summary: Event types you can subscribe to
      operationId: event_types_v1_webhooks_event_types_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Api-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: X-Anpheros-Acting-As
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-Acting-As
      - name: X-Anpheros-On-Behalf-Of
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-On-Behalf-Of
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
        '403':
          description: The credential's scope or the patient's consent does not allow this.
        '429':
          description: Rate limit exceeded; wait `Retry-After` seconds.
      security:
      - bearer: []
      - apiKey: []
      - oauth2:
        - patient/*.rs
        - patient/Observation.rs
        - patient/Observation.rs?category=laboratory
        - patient/Condition.rs
        - patient/MedicationStatement.rs
        - patient/DocumentReference.rs
        - patient/AllergyIntolerance.rs
        - offline_access
        - openid
        - fhirUser
        - anpheros/patterns
  /v1/webhooks/{endpoint_id}:
    get:
      tags:
      - Webhooks
      summary: One endpoint
      operationId: get_endpoint_v1_webhooks__endpoint_id__get
      parameters:
      - name: endpoint_id
        in: path
        required: true
        schema:
          type: string
          title: Endpoint Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Api-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: X-Anpheros-Acting-As
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-Acting-As
      - name: X-Anpheros-On-Behalf-Of
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-On-Behalf-Of
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
        '403':
          description: The credential's scope or the patient's consent does not allow this.
        '429':
          description: Rate limit exceeded; wait `Retry-After` seconds.
      security:
      - bearer: []
      - apiKey: []
      - oauth2:
        - patient/*.rs
        - patient/Observation.rs
        - patient/Observation.rs?category=laboratory
        - patient/Condition.rs
        - patient/MedicationStatement.rs
        - patient/DocumentReference.rs
        - patient/AllergyIntolerance.rs
        - offline_access
        - openid
        - fhirUser
        - anpheros/patterns
    patch:
      tags:
      - Webhooks
      summary: Change url, events, description or active
      operationId: update_endpoint_v1_webhooks__endpoint_id__patch
      parameters:
      - name: endpoint_id
        in: path
        required: true
        schema:
          type: string
          title: Endpoint Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Api-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: X-Anpheros-Acting-As
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-Acting-As
      - name: X-Anpheros-On-Behalf-Of
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-On-Behalf-Of
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointPatch'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
        '403':
          description: The credential's scope or the patient's consent does not allow this.
        '429':
          description: Rate limit exceeded; wait `Retry-After` seconds.
      security:
      - bearer: []
      - apiKey: []
      - oauth2:
        - patient/*.rs
        - patient/Observation.rs
        - patient/Observation.rs?category=laboratory
        - patient/Condition.rs
        - patient/MedicationStatement.rs
        - patient/DocumentReference.rs
        - patient/AllergyIntolerance.rs
        - offline_access
        - openid
        - fhirUser
        - anpheros/patterns
    delete:
      tags:
      - Webhooks
      summary: Remove an endpoint (pending deliveries are dropped)
      operationId: delete_endpoint_v1_webhooks__endpoint_id__delete
      parameters:
      - name: endpoint_id
        in: path
        required: true
        schema:
          type: string
          title: Endpoint Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Api-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: X-Anpheros-Acting-As
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-Acting-As
      - name: X-Anpheros-On-Behalf-Of
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-On-Behalf-Of
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
        '403':
          description: The credential's scope or the patient's consent does not allow this.
        '429':
          description: Rate limit exceeded; wait `Retry-After` seconds.
      security:
      - bearer: []
      - apiKey: []
      - oauth2:
        - patient/*.rs
        - patient/Observation.rs
        - patient/Observation.rs?category=laboratory
        - patient/Condition.rs
        - patient/MedicationStatement.rs
        - patient/DocumentReference.rs
        - patient/AllergyIntolerance.rs
        - offline_access
        - openid
        - fhirUser
        - anpheros/patterns
  /v1/webhooks/{endpoint_id}/rotate:
    post:
      tags:
      - Webhooks
      summary: New signing secret (shown once); the old one stops working immediately
      operationId: rotate_secret_v1_webhooks__endpoint_id__rotate_post
      parameters:
      - name: endpoint_id
        in: path
        required: true
        schema:
          type: string
          title: Endpoint Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Api-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: X-Anpheros-Acting-As
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-Acting-As
      - name: X-Anpheros-On-Behalf-Of
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-On-Behalf-Of
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
        '403':
          description: The credential's scope or the patient's consent does not allow this.
        '429':
          description: Rate limit exceeded; wait `Retry-After` seconds.
      security:
      - bearer: []
      - apiKey: []
      - oauth2:
        - patient/*.rs
        - patient/Observation.rs
        - patient/Observation.rs?category=laboratory
        - patient/Condition.rs
        - patient/MedicationStatement.rs
        - patient/DocumentReference.rs
        - patient/AllergyIntolerance.rs
        - offline_access
        - openid
        - fhirUser
        - anpheros/patterns
  /v1/webhooks/{endpoint_id}/ping:
    post:
      tags:
      - Webhooks
      summary: Send a test event to this endpoint
      operationId: ping_v1_webhooks__endpoint_id__ping_post
      parameters:
      - name: endpoint_id
        in: path
        required: true
        schema:
          type: string
          title: Endpoint Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Api-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: X-Anpheros-Acting-As
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-Acting-As
      - name: X-Anpheros-On-Behalf-Of
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-On-Behalf-Of
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
        '403':
          description: The credential's scope or the patient's consent does not allow this.
        '429':
          description: Rate limit exceeded; wait `Retry-After` seconds.
      security:
      - bearer: []
      - apiKey: []
      - oauth2:
        - patient/*.rs
        - patient/Observation.rs
        - patient/Observation.rs?category=laboratory
        - patient/Condition.rs
        - patient/MedicationStatement.rs
        - patient/DocumentReference.rs
        - patient/AllergyIntolerance.rs
        - offline_access
        - openid
        - fhirUser
        - anpheros/patterns
  /v1/webhooks/{endpoint_id}/deliveries:
    get:
      tags:
      - Webhooks
      summary: Delivery log of an endpoint, newest first
      operationId: deliveries_v1_webhooks__endpoint_id__deliveries_get
      parameters:
      - name: endpoint_id
        in: path
        required: true
        schema:
          type: string
          title: Endpoint Id
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - enum:
            - pending
            - delivered
            - failed
            - exhausted
            type: string
          - type: 'null'
          title: Status
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          default: 50
          title: Limit
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Api-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: X-Anpheros-Acting-As
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-Acting-As
      - name: X-Anpheros-On-Behalf-Of
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-On-Behalf-Of
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
        '403':
          description: The credential's scope or the patient's consent does not allow this.
        '429':
          description: Rate limit exceeded; wait `Retry-After` seconds.
      security:
      - bearer: []
      - apiKey: []
      - oauth2:
        - patient/*.rs
        - patient/Observation.rs
        - patient/Observation.rs?category=laboratory
        - patient/Condition.rs
        - patient/MedicationStatement.rs
        - patient/DocumentReference.rs
        - patient/AllergyIntolerance.rs
        - offline_access
        - openid
        - fhirUser
        - anpheros/patterns
  /v1/webhooks/{endpoint_id}/deliveries/redeliver-exhausted:
    post:
      tags:
      - Webhooks
      summary: 'Dead-letter: send every exhausted delivery again now'
      operationId: redeliver_exhausted_v1_webhooks__endpoint_id__deliveries_redeliver_exhausted_post
      parameters:
      - name: endpoint_id
        in: path
        required: true
        schema:
          type: string
          title: Endpoint Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Api-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: X-Anpheros-Acting-As
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-Acting-As
      - name: X-Anpheros-On-Behalf-Of
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-On-Behalf-Of
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
        '403':
          description: The credential's scope or the patient's consent does not allow this.
        '429':
          description: Rate limit exceeded; wait `Retry-After` seconds.
      security:
      - bearer: []
      - apiKey: []
      - oauth2:
        - patient/*.rs
        - patient/Observation.rs
        - patient/Observation.rs?category=laboratory
        - patient/Condition.rs
        - patient/MedicationStatement.rs
        - patient/DocumentReference.rs
        - patient/AllergyIntolerance.rs
        - offline_access
        - openid
        - fhirUser
        - anpheros/patterns
  /v1/webhooks/{endpoint_id}/deliveries/{delivery_id}/redeliver:
    post:
      tags:
      - Webhooks
      summary: Send a delivery again now
      operationId: redeliver_v1_webhooks__endpoint_id__deliveries__delivery_id__redeliver_post
      parameters:
      - name: endpoint_id
        in: path
        required: true
        schema:
          type: string
          title: Endpoint Id
      - name: delivery_id
        in: path
        required: true
        schema:
          type: string
          title: Delivery Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Api-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: X-Anpheros-Acting-As
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-Acting-As
      - name: X-Anpheros-On-Behalf-Of
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Anpheros-On-Behalf-Of
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
        '403':
          description: The credential's scope or the patient's consent does not allow this.
        '429':
          description: Rate limit exceeded; wait `Retry-After` seconds.
      security:
      - bearer: []
      - apiKey: []
      - oauth2:
        - patient/*.rs
        - patient/Observation.rs
        - patient/Observation.rs?category=laboratory
        - patient/Condition.rs
        - patient/MedicationStatement.rs
        - patient/DocumentReference.rs
        - patient/AllergyIntolerance.rs
        - offline_access
        - openid
        - fhirUser
        - anpheros/patterns
components:
  schemas:
    EndpointPatch:
      properties:
        url:
          anyOf:
          - type: string
            maxLength: 2000
          - type: 'null'
          title: Url
        events:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Events
        description:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Description
        active:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Active
      type: object
      title: EndpointPatch
    EndpointIn:
      properties:
        url:
          type: string
          maxLength: 2000
          title: Url
        events:
          items:
            type: string
          type: array
          title: Events
        description:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Description
      type: object
      required:
      - url
      title: EndpointIn
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: A project API key (`sk_test_…` sandbox, `sk_live_…` production) or an OAuth access token (`at_…`).
    apiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: The same project API key, as a header.
    oauth2:
      type: oauth2
      description: SMART on FHIR v2 scopes; authorization code with PKCE for a person's record, client_credentials for a project.
      flows:
        authorizationCode:
          authorizationUrl: https://platform.anpheros.com/oauth/authorize
          tokenUrl: https://platform.anpheros.com/oauth/token
          refreshUrl: https://platform.anpheros.com/oauth/token
          scopes:
            patient/*.rs: Read the whole record
            patient/Observation.rs: Read measurements and lab results
            patient/Observation.rs?category=laboratory: Read lab results only
            patient/Condition.rs: Read conditions
            patient/MedicationStatement.rs: Read medications
            patient/DocumentReference.rs: Read documents
            patient/AllergyIntolerance.rs: Read allergies
            offline_access: Refresh token
            openid: OpenID Connect
            fhirUser: Identity of the person
            anpheros/patterns: Pattern analysis on production records (separate patient consent)
        clientCredentials:
          tokenUrl: https://platform.anpheros.com/oauth/token
          scopes: {}
    firebase:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Firebase ID token of a developer (dashboard, Admin) or of a patient (/me).