Webhooks
Receive signed callbacks when async work completes
Webhooks
Configure a webhook URL and secret on your project (Console → Project → Settings). Scribeberry POSTs JSON when transcription, notes, or visit jobs finish or fail.
Events
| Event | When |
|---|---|
transcription.completed | Async transcription finished |
transcription.failed | Transcription failed |
note.completed | Synchronous or async note generation succeeded |
note.failed | Note generation failed |
visit.completed | Visit job finished (POST /jobs/visits) |
visit.failed | Visit job failed |
Payload shape
Verifying signatures
Each request includes:
X-Scribeberry-Event— event nameX-Scribeberry-Signature— HMAC-SHA256 hex of the raw JSON body using your webhook secretX-Scribeberry-Delivery-Id— unique delivery id (same aseventId)
Recompute the HMAC on the raw body and compare in constant time. Return 2xx quickly; we retry up to three times on failure.
Optional path
If you set a path suffix in transcription or visit job requests, it is appended to your base webhook URL (default path segment: /scribeberry).
REST reference
Event types and job flows are also documented in Swagger under Jobs and Notes.