Skip to main content

Platform Callback

Notice

This document is a machine-translated draft and is currently undergoing review. Some content may be inaccurate or differ from the original Korean version. For the most precise information, refer to the Korean documentation.

When major workflows such as uploads, transcoding, and content management are completed, Kollus VOD sends a notification (callback) to the URL designated by the customer. This enables real-time synchronization with external systems and workflow automation.


platform callback types

  • Upload callback
  • Transcoding callback
  • Content update callback
  • Content channel addition callback
  • Content channel deletion callback

How to configure callbacks

Callback URLs can be configured in the Kollus VOD console.


Callback flow


Communication specifications

delivery method

  • Method: POST
  • Content-Type: application/x-www-form-urlencoded
  • Delivery timing: Sent immediately upon event occurrence

Response requirements

The customer server must comply with the following conditions after receiving the request.

  • Success response: Return HTTP Status Code 200 (response body is ignored)
  • Failure determination: Any status code other than 200, or Timeout (registered in the retry queue)

Timeout limits

CategoryTime LimitDescription
Connect Timeout2 secondsTime limit for server connection attempt
Response Timeout3 secondsTime limit for waiting for a response after sending the request

Retry

Retry policy

If delivery fails due to a temporary network failure or customer server delay, the system automatically performs retries.

  • Retry interval: Every 5 minutes
  • Maximum attempts: 3 retries (4 total attempts including the initial delivery)
  • Log verification: All delivery and retry results are recorded in the log.

⚠️ Preventing duplicate callback reception

Due to network delays, even if the customer server successfully processes the request and sends a response, the Kollus system may recognize it as a Timeout and resend the callback.

  • Recommendation: The customer system must implement duplicate processing prevention logic to ensure data integrity even when the same event is received multiple times.

Request parameters

These are the parameter specifications sent for each event.

See Also

Refer to the following document for key (Key/ID) information.

Upload complete callback

ParameterTypeDescription
content_provider_keystringService account key
full_filenamestringOriginal file name including folder path
filenamestringOriginal file name
upload_file_keystringUpload file key

Transcoding complete callback

ParameterTypeDescription
content_provider_keystringService account key
filenamestringOriginal file name
upload_file_keystringUpload file key
transcoding_resultstringTranscoding result
  • success: Success
  • fail: Failure

Content update complete callback

ParameterTypeDescription
content_provider_keystringService account key
full_filenamestringOriginal file name including folder path
filenamestringOriginal file name
upload_file_keystringUpload file key
update_typestringUpdate type (content_*)

Content channel addition complete callback

ParameterTypeDescription
content_provider_keystringService account key
full_filenamestringOriginal file name including folder path
filenamestringOriginal file name
upload_file_keystringUpload file key
media_content_keystringMedia content key
channel_keystringIdentifier key of the channel where the content is registered
channel_namestringName of the channel where the content is registered
profile_keystringList of applied encoding profile keys (using | delimiter)
update_typestringUpdate type (channel_join)

Content channel deletion complete callback

ParameterTypeDescription
content_provider_keystringService account key
full_filenamestringOriginal file name including folder path
filenamestringOriginal file name
upload_file_keystringUpload file key
media_content_keystringMedia content key
channel_keystringIdentifier key of the channel where the content is registered
channel_namestringName of the channel where the content is registered
update_typestringUpdate type (channel_leave)