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

# Dispatch a recording to a webhook

> Fetches the recording (with transcript + summary), flattens it into a webhook payload, and POSTs it to the caller-supplied `webhook_url`. Stateless — deduplication is the orchestrator's job. A `200` with `success=false` means the dispatch ran end-to-end but your webhook URL returned a non-2xx status. **Pro license required.** A Basic key is rejected with `400` and `you are not a magic meal kits PRO user`.



## OpenAPI

````yaml /api-reference/plaud/openapi.json post /plaud/files/{id}/dispatch
openapi: 3.1.0
info:
  title: Magic Meal Kits — Plaud API
  version: 1.0.0
  description: >-
    Read your Plaud voice-recorder library — recordings, transcripts, AI
    summaries, note tabs, devices, and search — through your Magic Meal Kits
    server. Backs the **Plaud (Magic Meal Kits)** Make.com app.


    Your Plaud account credentials live server-side (Secret Manager) on your
    deployment; callers only send the MMK API key. Every endpoint requires a
    **Pro** license — a Basic key is rejected with `400` and `you are not a
    magic meal kits PRO user`.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://{deployment}/api/v1
    description: Your Magic Meal Kits deployment
    variables:
      deployment:
        default: magic-meal-kits-xxxxx.run.app
        description: Your Cloud Run host (without protocol)
security:
  - ApiKeyAuth: []
tags:
  - name: User
    description: Account profile and membership.
  - name: Files
    description: List, inspect, and bundle recordings.
  - name: Content
    description: Transcripts, summaries, note tabs, and audio.
  - name: Search
    description: Full-text search across transcripts.
  - name: Devices
    description: Bound Plaud hardware.
  - name: Webhooks
    description: Polling source for new-recording triggers.
  - name: Folders
    description: 'Tags (used as folders): list, create, assign/clear, and one-call organize.'
  - name: AI
    description: >-
      Auto transcribe + summarize, task status, transcription quota, and summary
      models.
  - name: System
    description: Diagnostics, membership, config, and background-task status.
paths:
  /plaud/files/{id}/dispatch:
    post:
      tags:
        - Webhooks
      summary: Dispatch a recording to a webhook
      description: >-
        Fetches the recording (with transcript + summary), flattens it into a
        webhook payload, and POSTs it to the caller-supplied `webhook_url`.
        Stateless — deduplication is the orchestrator's job. A `200` with
        `success=false` means the dispatch ran end-to-end but your webhook URL
        returned a non-2xx status. **Pro license required.** A Basic key is
        rejected with `400` and `you are not a magic meal kits PRO user`.
      operationId: dispatchPlaudFile
      parameters:
        - $ref: '#/components/parameters/FileId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DispatchRequest'
            example:
              webhook_url: https://hook.make.com/abc123
              delivery_id: d-42
              idempotency_key: note:ceb63f88:1719460000000
      responses:
        '200':
          description: Dispatch completed — inspect `success` and `webhook_status_code`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DispatchResponse'
        '400':
          description: >-
            Malformed body or invalid `webhook_url` scheme (must be http/https);
            also the Basic-key gate `you are not a magic meal kits PRO user`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DispatchResponse'
        '401':
          $ref: '#/components/responses/PlaudAuthError'
        '404':
          description: The recording does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DispatchResponse'
        '409':
          description: The recording is not ready yet (no transcript or no summary).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DispatchResponse'
        '502':
          description: Plaud upstream error while fetching the recording.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DispatchResponse'
components:
  parameters:
    FileId:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: Plaud recording (file) ID.
  schemas:
    DispatchRequest:
      type: object
      required:
        - webhook_url
      properties:
        webhook_url:
          type: string
          description: Destination URL (must be http:// or https://).
        delivery_id:
          type: string
          description: >-
            Opaque id echoed back in the response; the handler does not dedupe
            on it.
        idempotency_key:
          type: string
          description: Opaque key logged for the orchestrator; not inspected here.
        transcript_format:
          type: string
          enum:
            - text
            - markdown
            - srt
            - vtt
            - json
            - plain
          description: >-
            Rendering of the outgoing `transcript` string. Omit for legacy plain
            text.
        include_list_metadata:
          type: boolean
          default: false
          description: >-
            Opt into note.version_ms/edit_from/md5 on the payload (costs an
            extra upstream list call).
    DispatchResponse:
      type: object
      properties:
        success:
          type: boolean
          description: True only when the webhook returned a 2xx status.
        delivery_id:
          type: string
        webhook_status_code:
          type: integer
          description: HTTP status your webhook returned.
        webhook_response_snippet:
          type: string
          description: First ~1 KB of the webhook's response body.
        duration_ms:
          type: integer
          format: int64
        error:
          type: string
          description: Set when the dispatch failed or the webhook returned non-2xx.
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
  responses:
    PlaudAuthError:
      description: >-
        Plaud credentials rejected (revoked/expired) — reconnect your Plaud
        account.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: >-
        Your deployment's API key (MMK_API_KEY). Your Plaud account credentials
        are stored server-side — you do not send them.

````