Skip to main content
POST
Dispatch a recording to a webhook

Authorizations

X-API-KEY
string
header
required

Your deployment's API key (MMK_API_KEY). Your Plaud account credentials are stored server-side — you do not send them.

Path Parameters

id
string
required

Plaud recording (file) ID.

Body

application/json
webhook_url
string
required

Destination URL (must be http:// or https://).

delivery_id
string

Opaque id echoed back in the response; the handler does not dedupe on it.

idempotency_key
string

Opaque key logged for the orchestrator; not inspected here.

transcript_format
enum<string>

Rendering of the outgoing transcript string. Omit for legacy plain text.

Available options:
text,
markdown,
srt,
vtt,
json,
plain
include_list_metadata
boolean
default:false

Opt into note.version_ms/edit_from/md5 on the payload (costs an extra upstream list call).

Response

Dispatch completed — inspect success and webhook_status_code.

success
boolean

True only when the webhook returned a 2xx status.

delivery_id
string
webhook_status_code
integer

HTTP status your webhook returned.

webhook_response_snippet
string

First ~1 KB of the webhook's response body.

duration_ms
integer<int64>
error
string

Set when the dispatch failed or the webhook returned non-2xx.