[ API Reference ]
Event Types
Every webhook request carries the same envelope: the event id, its type, when it occurred, the team id and an event-specific payload object. Event types take the form <source>.<action> and are grouped by product family. Your endpoint receives only the events it selected in its configuration.
Event List
| Event | Family | When it is sent |
|---|---|---|
| page.changed | Detector | When a monitored page's DOM hash or visual diff crosses the threshold. |
| price.changed | Detector | When a value tracked with a CSS selector (price, stock) changes. |
| monitor.failed | Detector | When a check fails 3 times in a row (timeout, 4xx/5xx). |
| document.processed | PDF Editör | When OCR of an uploaded document completes. |
| document.redacted | PDF Editör | When redaction rules have been applied and the output is ready. |
| signature.compared | Signature API | When a comparison completes or fails. |
| transcription.completed | Altyazı | When the transcription, and any translation, job finishes. |
| credits.low | Credits | When the balance drops below the threshold set for the team. |
| credits.topped_up | Credits | When a manual or automatic top-up reaches the balance. |
Example Payloads
{
"id": "evt_live_89124a9c_f901",
"event_type": "price.changed",
"created_at": "2026-10-29T08:02:11Z",
"team_id": "team_4Qm1",
"test": false,
"payload": {
"monitor_id": "mon_42",
"url": "https://shop.example.com/product/123",
"selector": ".product-price",
"previous_value": "$49.00",
"current_value": "$43.00",
"checked_at": "2026-10-29T08:02:09Z"
}
}{
"id": "evt_live_2b71c0de_a113",
"event_type": "document.redacted",
"created_at": "2026-10-29T08:15:40Z",
"team_id": "team_4Qm1",
"test": false,
"payload": {
"document_id": "doc_9Lx2",
"pages": 14,
"redactions": 37,
"rules": ["national_id", "iban", "phone"],
"export_formats": ["pdf", "json", "docx"]
}
}{
"id": "evt_live_5e0f7a21_c42d",
"event_type": "signature.compared",
"created_at": "2026-10-29T09:14:07Z",
"team_id": "team_4Qm1",
"test": false,
"payload": {
"comparison_id": "cmp_7Hk2pQx91",
"status": "completed",
"score": 91,
"band": "strong_match",
"report_ready": true
}
}{
"id": "evt_live_7c33e810_0b9e",
"event_type": "transcription.completed",
"created_at": "2026-10-29T10:40:02Z",
"team_id": "team_4Qm1",
"test": false,
"payload": {
"job_id": "trj_6Pw0",
"duration_seconds": 1824,
"language": "tr",
"translations": ["en"],
"formats": ["srt", "vtt"]
}
}{
"id": "evt_live_a90d4b6f_11e7",
"event_type": "credits.low",
"created_at": "2026-10-29T11:00:00Z",
"team_id": "team_4Qm1",
"test": false,
"payload": {
"balance_usd": 4.82,
"threshold_usd": 5.00,
"auto_top_up": false
}
}New fields may be added to the envelope or the
payload object at any time; ignore fields you do not recognise. Removing a field or changing its meaning only happens with a new API version.