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

# Receive Analysis

> Xosum.am will send a POST request to this URL once a checklist-based analysis is complete. This endpoint **does not require** any Authorization header. Use the `secret` field to verify the source.
Note: This is a callback URL provided by the user and is not part of the public Xosum.am API.


<Info>
  **You host this endpoint.** Xosum sends this payload to a webhook URL **you** host whenever a checklist analysis finishes for a transcription that was created with a `checklistId`. The path `/your-analysis-webhook-url` is a placeholder for whatever publicly-reachable URL you configure in your account.
</Info>

Verify the `secret` field matches your `webhookSecret`, return `200 OK` quickly, and process the `results` map asynchronously. Each entry in `results` is keyed by the checklist question ID; see `AnalysisResultEntry` in the schema below for the per-question shape.


## OpenAPI

````yaml POST /your-analysis-webhook-url
openapi: 3.0.3
info:
  title: Xosum.am API
  description: >
    The Xosum.am API enables business customers to upload audio for
    transcription and receive results via webhook. All transcription results are
    also accessible via the web interface at
    [https://app.xosum.am](https://app.xosum.am).

    API access is exclusive to Business plan users. Authentication is handled
    via Bearer API keys.
  version: 1.0.0
servers:
  - url: https://app.xosum.am
    description: Production API server
security:
  - BearerAuth: []
paths:
  /your-analysis-webhook-url:
    post:
      summary: Webhook callback for checklist analysis results
      description: >
        Xosum.am will send a POST request to this URL once a checklist-based
        analysis is complete. This endpoint **does not require** any
        Authorization header. Use the `secret` field to verify the source.

        Note: This is a callback URL provided by the user and is not part of the
        public Xosum.am API.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookAnalysisPayload'
      responses:
        '200':
          description: Webhook received and acknowledged.
        '400':
          description: Bad request or invalid webhook secret.
components:
  schemas:
    WebhookAnalysisPayload:
      type: object
      properties:
        event_type:
          type: string
          enum:
            - analysis_ready
          description: Event type for checklist analysis completion.
        secret:
          type: string
          description: Webhook secret to validate authenticity.
        docId:
          type: string
          description: Transcription/recording job ID.
        analysisId:
          type: string
          description: Analysis document ID.
        metadata:
          type: object
          description: Metadata passed during creation.
        checklistId:
          type: string
          nullable: true
          description: Checklist ID used for this analysis (if present).
        checklistName:
          type: string
          nullable: true
          description: Checklist name snapshot captured at analysis time (if present).
        results:
          type: object
          description: >
            Map keyed by checklist question ID, where each value contains the
            analysis result.
          additionalProperties:
            $ref: '#/components/schemas/AnalysisResultEntry'
        link:
          type: string
          format: uri
          description: Direct URL to the recording details inside Xosum.am.
    AnalysisResultEntry:
      type: object
      description: >
        One checklist question result entry. The shape depends on checklist
        question type: - yes_no: answer is "yes" | "no" | "cannot_tell" -
        grade_1_10: answer is a number (typically 1-10)
      properties:
        answer:
          oneOf:
            - type: string
            - type: number
          description: The answer value for the checklist question.
        comment:
          type: string
          description: Brief justification (often includes quotes/reasoning).
        question:
          type: string
          nullable: true
          description: >-
            The human-readable question text (enriched by the backend when
            available).
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key

````