file.uploaded

Webhook

POST

file.uploaded

Fired when a file is uploaded (including ingest from external sources like Box, Dropbox, or direct upload). Status may be ok (file ready) or error (ingest failed). When status is ok, the file object contains full metadata including a download URL.

Request

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://your-api-server.com' \
--header 'Content-Type: application/json' \
--data '{
    "object": "event",
    "id": "c1d2e3f4-1234-11f1-aaaa-bbbbcccc0002",
    "type": "file.uploaded",
    "data": {
        "object": "other",
        "status": "ok",
        "request_id": "req-9c0b3f",
        "file": {
            "object": "file",
            "id": 555111,
            "name": "mix_v2.wav",
            "is_folder": false,
            "parent_id": 555100,
            "size": 32457621,
            "url": "https://cdn.pibox.com/.../mix_v2.wav",
            "removal_protection": false,
            "task_load_protection": false
        }
    }
}'

Response Example

{}

Modified at 2026-05-25 15:52:18

Delete Webhook Endpoint

file.renamed