ScribeberryScribeberry Docs

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

EventWhen
transcription.completedAsync transcription finished
transcription.failedTranscription failed
note.completedSynchronous or async note generation succeeded
note.failedNote generation failed
visit.completedVisit job finished (POST /jobs/visits)
visit.failedVisit job failed

Payload shape

{
  "event": "note.completed",
  "eventId": "uuid",
  "timestamp": "2026-11-03T12:00:00.000Z",
  "projectId": "project-uuid",
  "data": { }
}

Verifying signatures

Each request includes:

  • X-Scribeberry-Event — event name
  • X-Scribeberry-Signature — HMAC-SHA256 hex of the raw JSON body using your webhook secret
  • X-Scribeberry-Delivery-Id — unique delivery id (same as eventId)

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.

On this page