Events

Upload Failed

Webhook notification payload for upload.failed event. Details of the payload structure when an upload has failed.

Payload data structure for upload.failed and upload.expired events

upload

object

required

created_at

string

date-time

required

Timestamp when the upload was created

Examples:

2025-01-01T12:00:00Z

expires_at

string

date-time

required

Timestamp when the upload will expire

Examples:

2025-01-01T12:00:00Z

string

required

Unique identifier of the upload

Examples:

upl_2G6MJiNz71bHQGNzGwKx5cJwPFS

status

string

required

Current status of the upload

Available options:

waitingcompletedfailedexpired

Examples:

waiting

updated_at

string

date-time

required

Timestamp when the upload was updated

Examples:

2025-01-01T12:00:00Z

completion_url

string

Short-lived completion capability, returned only on creation. POST after a successful PUT before expires_at. Requires no API key. Repeated valid calls are idempotent.

error

object

Error message of the upload

detail

string

required

Additional error details or output

message

string

required

Main error message

type

string

required

Type of error

Available options:

setupffmpegsourceuploaddownloadingestjobunexpectedpermissiontimeoutcancelled

metadata

object

Additional metadata for the upload

Examples:

map[key1:value1 key2:value2]

source_id

string

SourceId is the id of the source that was created from the upload

Examples:

src_2G6MJiNz71bHQGNzGwKx5cJwPFS

storage_id

string

Resolved Storage selected when the Upload was created. Absent for historical uploads.

upload_url

string

Presigned PUT URL, returned only when creating an Upload session. Call completion_url after the PUT succeeds.

Examples:

https://s3.amazonaws.com/bucket/key

Upload Completed

Upload Expired