API Reference

Webhook call example

Example video

Available status:

DRAFT, CONVERTING, CONVERTED, FAILED

{
  "action": "video.changeStatus",
  "video_id": "ID",
  "folder_id": "ID",
  "status": "CONVERTING",
  "video_external_id": "EXTERNAL_ID"
}

Example live

Available status:

ONLINE, FINISHED, FINISHED_IMPORTED

{
  "action": "live.changeStatus",
  "status": "ONLINE",
  "video_id": "ID"
}

Webhook Response Protocol

Requirement:

2xx Responses: Webhooks must acknowledge with a 2xx HTTP status code upon successful receipt. This signals successful processing.

4xx ~ 5xx Responses: Any response outside the 2xx range triggers retry logic. The system interprets these as failures, including 4xx and 5xx status codes.

Retry Logic:

Retries: Failure to respond with a 2xx code results in repeated delivery attempts to ensure reliability.

Action: Ensure your endpoint correctly processes and responds to webhook payloads with a 2xx status to avoid unnecessary retries.