MediaJobSucceededPayload `media.job.succeeded@1`

Generated at 2026-09-23 23:26:36 UTC from openvibe-contracts v0.33.0 and openvibe-sdk v0.5.0.

Version: 1.0.0
Owner: media
Visibility: first-party
Status: active
Compatibility: backward
Decision: ADR-004
Schema: https://openvibe.network/contracts/events/payloads/media.job.succeeded.v1.json

media.job.succeeded v1 (OpenVibe.Media server/jobs/queue.js succeed; server/events.js recordJob). The job finished. Its result (thumbnail.regenerate { url, kind, id }, object.split { source_id, parts, … }, object.remux { source_id, object_id, … }, invariant.scan { thresholds, counts, … }) is not in the event: has_result says whether there is one to GET. Emitted in the SQLite transaction that records the state change, so the event exists if and only if the change committed; it goes to OpenVibe.Events only (no app webhook). The payload is an event projection of the job (queue.jobEvent): its identity, state, counters, stable error_code, times and has_result. Deliberately left out, because events travel beyond the tenant: the tenant's params (object.split keeps whatever the caller sent), the caller's idempotency_key, the free-text error (raw handler or ffmpeg output), the result (thumbnail.regenerate's is the thumbnail URL, of a private VOD too), created_by/decided_by and owner_user_id (tenant-local user ids), and the handler's checkpoint, lease and request hash. GET the job with a tenant token for params/result/error (GET /api/v2/:app/jobs/:id with a token for app_id; has_result says whether there is a result to fetch). Times are ISO 8601 UTC (YYYY-MM-DDTHH:MM:SS.sssZ) or null. Jobs of developer-project sandbox tenants are not announced. Envelope: subject { type: job, id: <id> }, visibility internal, priority important, actor service:media.

Fields

Field	Type	Required	Description	Constraints
`id`	string	yes	The job. GET /api/v2/:app/jobs/:id with a token for app_id answers the rest of it.	`pattern ^mjob_[0-9A-HJKMNP-TV-Z]{26}$`
`app_id`	string	yes	The tenant that owns the job: an app (live, tools…) or a developer project's production tenant (prj_…).	`minLength 1` `maxLength 200`
`object_id`	string \| null	yes	The object the job works on; null for a tenant-wide job (invariant.scan).	`maxLength 200`
`type`	string	yes	Job type: thumbnail.regenerate, invariant.scan, object.split or object.remux.	`pattern ^[a-z][a-z0-9]*\.[a-z0-9_.]+$` `maxLength 80`
`status`	const	yes		`= "succeeded"`
`attempts`	integer	yes	Attempts started, the successful one included.	`minimum 1`
`max_attempts`	integer	yes		`minimum 1` `maximum 10`
`error_code`	null	yes	A success clears the last failure.
`cancel_requested`	boolean	yes	Its owner asked a running job to stop.
`has_result`	boolean	yes	The job holds a result. The result itself is never in the event: GET the job with a tenant token for it.
`run_after`	null	yes
`decided_at`	string \| null	yes	When its owner approved it, or cancelled it while it was proposed or queued; null otherwise.	`pattern ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,3})?Z$` `format date-time`
`created_at`	string	yes		`pattern ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,3})?Z$` `format date-time`
`updated_at`	string	yes		`pattern ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,3})?Z$` `format date-time`
`started_at`	string	yes	The first attempt's start.	`pattern ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,3})?Z$` `format date-time`
`finished_at`	string	yes		`pattern ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,3})?Z$` `format date-time`

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

Valid: split

{
  "id": "mjob_01JAB3C4D5E6F7G8H9J0K1MNPQ",
  "app_id": "live",
  "object_id": "med_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "type": "object.split",
  "status": "succeeded",
  "attempts": 1,
  "max_attempts": 3,
  "error_code": null,
  "cancel_requested": false,
  "has_result": true,
  "run_after": null,
  "decided_at": null,
  "created_at": "2026-09-23T18:02:11.000Z",
  "updated_at": "2026-09-23T18:31:02.000Z",
  "started_at": "2026-09-23T18:02:12.000Z",
  "finished_at": "2026-09-23T18:31:02.000Z"
}

Valid: thumbnail-after-a-retry

{
  "id": "mjob_01JAB3C4D5E6F7G8H9J0K1MNPQ",
  "app_id": "live",
  "object_id": "med_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "type": "thumbnail.regenerate",
  "status": "succeeded",
  "attempts": 2,
  "max_attempts": 2,
  "error_code": null,
  "cancel_requested": false,
  "has_result": true,
  "run_after": null,
  "decided_at": null,
  "created_at": "2026-09-23T18:02:11.000Z",
  "updated_at": "2026-09-23T18:03:02.000Z",
  "started_at": "2026-09-23T18:02:12.000Z",
  "finished_at": "2026-09-23T18:03:02.000Z"
}

Rejected: carries-result

{
  "id": "mjob_01JAB3C4D5E6F7G8H9J0K1MNPQ",
  "app_id": "live",
  "object_id": "med_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "type": "thumbnail.regenerate",
  "status": "succeeded",
  "attempts": 1,
  "max_attempts": 3,
  "error_code": null,
  "cancel_requested": false,
  "has_result": true,
  "run_after": null,
  "decided_at": null,
  "created_at": "2026-09-23T18:02:11.000Z",
  "updated_at": "2026-09-23T18:02:14.000Z",
  "started_at": "2026-09-23T18:02:12.000Z",
  "finished_at": "2026-09-23T18:02:14.000Z",
  "result": {
    "url": "/t/vod-4211-1.jpg",
    "kind": "vod",
    "id": 4211
  }
}

Rejected: with-error-code

{
  "id": "mjob_01JAB3C4D5E6F7G8H9J0K1MNPQ",
  "app_id": "live",
  "object_id": "med_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "type": "object.split",
  "status": "succeeded",
  "attempts": 1,
  "max_attempts": 3,
  "error_code": "interrupted",
  "cancel_requested": false,
  "has_result": true,
  "run_after": null,
  "decided_at": null,
  "created_at": "2026-09-23T18:02:11.000Z",
  "updated_at": "2026-09-23T18:31:02.000Z",
  "started_at": "2026-09-23T18:02:12.000Z",
  "finished_at": "2026-09-23T18:31:02.000Z"
}

Rejected: without-has-result

{
  "id": "mjob_01JAB3C4D5E6F7G8H9J0K1MNPQ",
  "app_id": "live",
  "object_id": "med_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "type": "object.split",
  "status": "succeeded",
  "attempts": 1,
  "max_attempts": 3,
  "error_code": null,
  "cancel_requested": false,
  "run_after": null,
  "decided_at": null,
  "created_at": "2026-09-23T18:02:11.000Z",
  "updated_at": "2026-09-23T18:31:02.000Z",
  "started_at": "2026-09-23T18:02:12.000Z",
  "finished_at": "2026-09-23T18:31:02.000Z"
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('media.job.succeeded@1', value);   // { valid, errors: [{ path, message }] }

MediaJobSucceededPayload media.job.succeeded@1

Fields

Examples

Validate

MediaJobSucceededPayload `media.job.succeeded@1`