REST API/WEBHOOKS
Webhooks
EdithPro sends a POST to your endpoint when something happens. Add endpoints in Dashboard › Developer › Webhooks.
On this page
Event types #
EventWhen
recording.createdA recording starts or an upload is received.
recording.readyProcessing finished and the video can be watched.
recording.deletedA recording was deleted.
transcript.readyThe transcript and summary are ready.
document.readyA generated document is ready.
screenshot.createdA screenshot was saved.
comment.createdSomeone commented on a recording.
video_request.respondedSomeone recorded a video from a request link.
Payload #
POST to your endpoint
{ "id": "evt_5mq1", "type": "recording.ready", "created_at": "2026-10-06T14:16:02Z", "data": { "id": "rec_8f2kq1", "object": "recording", "status": "ready", "share_url": "https://edithpro.app/v/8f2kq1" }}
Verify signatures #
Every request has an EdithPro-Signature header: an HMAC SHA-256 of the raw body, signed with your endpoint’s secret. Reject requests where it doesn’t match.
server.js
import crypto from 'crypto'; function isValid(rawBody, header, secret) { const expected = crypto.createHmac('sha256', secret).update(rawBody).digest('hex'); return crypto.timingSafeEqual(Buffer.from(header), Buffer.from(expected));}
- Respond with any 2xx status within 10 seconds.
- Failed deliveries are retried [up to 8 times over 24 hours]. [CONFIRM]
- Use the event id to ignore duplicates.
Was this page helpful? REST API v1 draft · Edit this page