Events

info

You can use https://webhook.site for testing the response of a webhook event

File

Description

Get notified whenever a new file is created or deleted.

Supported Types

Create
Delete

Payload

{
    "event": {
        "name": "file",
        "type": "create",
        "traceId": "CG.923f7472-b12b-4d5b-ba5a-d26f1d8c6b4c"
    },
    "payload": {
        "orgId": 57923,
        "type": "file",
        "s3Bucket": "erase-erase-erasebg-assets",
        "s3Key": "uploads/documentation/original/878278d5-8b14-439e-9f62-3a837d3588ce.png",
        "name": "nv-media-tejas-for-artstation1-4nCTf8eJn",
        "path": "",
        "fileId": "nv-media-tejas-for-artstation1-4nCTf8eJn",
        "access": "public-read",
        "tags": [],
        "metadata": {
           "source": "direct"
        },
        "format": "png",
        "assetType": "image",
        "size": 477235,
        "width": 1920,
        "height": 1080,
        "context": {
        "steps": [],
        "req": {
            "headers": {},
            "query": {}
        },
        "meta": {
            "size": 477235,
            "height": 1080,
            "width": 1920,
            "format": "png",
            "assetType": "image"
        }
    }
}

Folder

Description

Get notified whenever a new folder is created.

Supported Types

Create

Payload

{
    "event": {
        "name": "folder",
        "type": "create",
        "traceId": "CG.486f2131-0d2b-44ab-a324-1e1b38ff972e"
    },
    "payload": {
        "_id": "75cae678-e030-4d46-bf02-088291f29fdb",
        "name": "folder-name",
        "path": "",
        "isActive": true
    }
}

Ping

Description

Here's a sample payload of a ping event when you test the webhook configuration.

Payload

{
    "event": {
        "name": "ping",
        "type": "push",
        "traceId": "TS.6cbe2275-43ac-4ca7-9046-c855d8a4bc17"
    },
    "payload": {
        "ping": {
            "key1": "val1",
            "key2": "val2"
        }
    }
}