Webhooks

Get notified the moment a job or pipeline changes state — no polling required.

What you can subscribe to

Register a webhook URL to receive events as your work progresses. Events cover both individual jobs and bundled pipelines:

  • Job events — stage transitions and terminal states (completed / failed).
  • Pipeline events — completed, partially failed, or expired bundles, plus pipeline.awaiting_review when a workflow pauses for you to approve the transcript.

If you use the review pause

pipeline.awaiting_review is the only signal that a workflow is waiting on you — there is nothing to poll for and the bundle is never auto-refunded while it waits. It is included by default when you subscribe to pipeline events.

You can filter which events each webhook receives, so you only get the notifications you care about.

Verifying signatures

Each webhook has its own signing secret (prefixed whsec_). VocaSync signs every delivery with HMAC so you can confirm a payload genuinely came from us and wasn’t tampered with in transit. Each payload also carries a digest you can check.

Always verify before acting

Treat the signing secret like a password and verify the signature on every request before trusting the payload. The exact header names and verification steps are in the API reference.

Delivery & retries

Deliveries are tracked, and failed attempts are retried automatically. Make your endpoint idempotent — the same event may be delivered more than once — by de-duplicating on the event identifier.

Related