事件

每个事件对应 CKBox 在特定环境中可能发生的特定操作。 此外，每个事件都有一个特定有效负载格式，其中包含相关的事件信息。

在使用 Webhooks 之前，请熟悉该功能的基本原理。 您可以在 概述 指南中阅读有关使用 Webhooks 的更多信息。

# 资产

您可以为 CKBox 中的资产触发以下事件。

# 资产上传

名称：asset.uploaded
说明：每当文件上传到类别或文件夹时触发。

# 有效负载

• workspace_id – 初始化操作的工作区标识符。
• asset – 上传资产的详细信息。
• user – 执行此操作的用户的详细信息。

# 示例

以下示例显示了用户上传文件后发送的 webhook 请求。

{
    environment_id: '6afdca1ba1e38969dea1',
    event: 'asset.uploaded',
    payload: {
        workspace_id: '80e839331c4d8827c474',
        asset: {
            id: '-1zT3SPzjuEv',
            name: 'Cupcake',
            extension: 'jpeg',
            url: 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/file',
            images_urls: {
                '192': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/192.webp',
                '384': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/384.webp',
                '576': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/576.webp',
                '768': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/768.webp',
                '960': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/960.webp',
                '1152': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1152.webp',
                '1344': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1344.webp',
                '1536': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1536.webp',
                '1728': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1728.webp',
                '1920': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1920.webp',
                default: 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1920.jpeg'
            },
            mime_type: 'image/jpeg',
            category_id: '1f0ca0db-d0fa-4b03-9703-9f152615ed0c',
            size_in_bytes: 523625,
            tags: [],
            metadata: { 
                description: 'An image of a cupcake', 
                custom_attributes: {}
            }
        },
        user: { id: 'user-1', role: 'User' }
    },
    sent_at: '2024-02-18T18:03:18.815Z'
}

# 资产修改

名称：asset.modified
说明：当资产被修改时触发。

# 有效负载

• workspace_id – 初始化操作的工作区标识符。
• asset – 修改后的资产的详细信息。
• asset_before_modification – 修改前的资产快照。
• user – 执行此操作的用户的详细信息。

# 示例

以下示例显示了用户修改资产后发送的 webhook 请求。

{
    environment_id: '6afdca1ba1e38969dea1',
    event: 'asset.modified',
    payload: {
        workspace_id: '80e839331c4d8827c474',
        asset: {
            id: '-1zT3SPzjuEv',
            name: 'Cupcake',
            extension: 'jpeg',
            url: 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/file',
            images_urls: {
                '192': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/192.webp',
                '384': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/384.webp',
                '576': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/576.webp',
                '768': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/768.webp',
                '960': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/960.webp',
                '1152': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1152.webp',
                '1344': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1344.webp',
                '1536': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1536.webp',
                '1728': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1728.webp',
                '1920': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1920.webp',
                default: 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1920.jpeg'
            },
            mime_type: 'image/jpeg',
            category_id: '1f0ca0db-d0fa-4b03-9703-9f152615ed0c',
            size_in_bytes: 523625,
            tags: [ 'foo' ],
            metadata: { 
                description: 'Updated description!', 
                custom_attributes: {}
            }
        },
        asset_before_modification: {
            id: '-1zT3SPzjuEv',
            name: 'Cupcake',
            extension: 'jpeg',
            url: 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/file',
            images_urls: {
                '192': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/192.webp',
                '384': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/384.webp',
                '576': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/576.webp',
                '768': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/768.webp',
                '960': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/960.webp',
                '1152': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1152.webp',
                '1344': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1344.webp',
                '1536': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1536.webp',
                '1728': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1728.webp',
                '1920': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1920.webp',
                default: 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1920.jpeg'
            },
            mime_type: 'image/jpeg',
            category_id: '1f0ca0db-d0fa-4b03-9703-9f152615ed0c',
            size_in_bytes: 523625,
            tags: [],
            metadata: { 
                description: 'An image of a cupcake', 
                custom_attributes: {}
            }
        },
        user: { id: 'user-1', role: 'User' }
    },
    sent_at: '2024-02-18T18:07:34.497Z'
}

# 资产删除

名称：asset.removed
说明：当资产被删除时触发。

# 有效负载

• workspace_id – 初始化操作的工作区标识符。
• asset – 删除资产的详细信息。
• user – 执行此操作的用户的详细信息。

# 示例

以下示例显示了用户删除资产后发送的 webhook 请求。

{
    environment_id: '6afdca1ba1e38969dea1',
    event: 'asset.removed',
    payload: {
        workspace_id: '80e839331c4d8827c474',
        asset: {
            id: '-1zT3SPzjuEv',
            name: 'Cupcake',
            extension: 'jpeg',
            url: 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/file',
            images_urls: {
                '192': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/192.webp',
                '384': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/384.webp',
                '576': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/576.webp',
                '768': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/768.webp',
                '960': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/960.webp',
                '1152': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1152.webp',
                '1344': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1344.webp',
                '1536': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1536.webp',
                '1728': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1728.webp',
                '1920': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1920.webp',
                default: 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/-1zT3SPzjuEv/images/1920.jpeg'
            },
            mime_type: 'image/jpeg',
            category_id: '1f0ca0db-d0fa-4b03-9703-9f152615ed0c',
            size_in_bytes: 523625,
            tags: [ 'foo' ],
            metadata: { 
                description: 'An image of a cupcake', 
                custom_attributes: {}
            }
        },
        user: { id: 'user-1', role: 'User' }
    },
    sent_at: '2024-02-18T18:09:52.989Z'
}

# 资产复制

名称：asset.copied
说明：当资产被复制时触发。

# 有效负载

• workspace_id – 初始化操作的工作区标识符。
• asset – 删除资产的详细信息。
• source_asset – 源资产的详细信息。
• user – 执行此操作的用户的详细信息。

# 示例

以下示例显示了用户复制资产后发送的 webhook 请求。

{
    environment_id: '6afdca1ba1e38969dea1',
    event: 'asset.copied',
    payload: {
        workspace_id: '80e839331c4d8827c474',
        asset: {
            id: 'ZXs11paEIP72',
            name: 'Cupcake',
            extension: 'jpeg',
            url: 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/ZXs11paEIP72/file',
            images_urls: {
                '192': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/ZXs11paEIP72/images/192.webp',
                '384': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/ZXs11paEIP72/images/384.webp',
                '576': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/ZXs11paEIP72/images/576.webp',
                '768': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/ZXs11paEIP72/images/768.webp',
                '960': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/ZXs11paEIP72/images/960.webp',
                '1152': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/ZXs11paEIP72/images/1152.webp',
                '1344': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/ZXs11paEIP72/images/1344.webp',
                '1536': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/ZXs11paEIP72/images/1536.webp',
                '1728': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/ZXs11paEIP72/images/1728.webp',
                '1920': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/ZXs11paEIP72/images/1920.webp',
                default: 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/ZXs11paEIP72/images/1920.jpeg'
            },
            mime_type: 'image/jpeg',
            category_id: '1f0ca0db-d0fa-4b03-9703-9f152615ed0c',
            folder_id: 'W_g4u6ZEHxuO',
            size_in_bytes: 523625,
            tags: [],
            metadata: { 
                description: 'An image of a cupcake', 
                custom_attributes: {}
            }
        },
        source_asset: {
            id: '_DpyO7eRxHtT',
            name: 'Cupcake',
            extension: 'jpeg',
            url: 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/file',
            images_urls: {
                '192': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/192.webp',
                '384': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/384.webp',
                '576': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/576.webp',
                '768': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/768.webp',
                '960': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/960.webp',
                '1152': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/1152.webp',
                '1344': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/1344.webp',
                '1536': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/1536.webp',
                '1728': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/1728.webp',
                '1920': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/1920.webp',
                default: 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/1920.jpeg'
            },
            mime_type: 'image/jpeg',
            category_id: '1f0ca0db-d0fa-4b03-9703-9f152615ed0c',
            size_in_bytes: 523625,
            tags: [],
            metadata: { 
                description: 'An image of a cupcake', 
                custom_attributes: {}
            }
        },
        user: { id: 'user-1', role: 'User' }
    },
    sent_at: '2024-02-18T18:29:11.602Z'
}

# 资产覆盖

名称：asset.overwritten
说明：当资产内容被覆盖时触发。

# 有效负载

• workspace_id – 初始化操作的工作区标识符。
• asset – 覆盖的资产的详细信息。
• user – 执行此操作的用户的详细信息。

# 示例

以下示例显示了用户覆盖资产后发送的 webhook 请求。

{
    environment_id: '6afdca1ba1e38969dea1',
    event: 'asset.overwritten',
    payload: {
        workspace_id: '80e839331c4d8827c474',
        asset: {
            id: '_DpyO7eRxHtT',
            name: 'Cupcake',
            extension: 'jpeg',
            url: 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/file',
            images_urls: {
                '192': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/192.webp',
                '384': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/384.webp',
                '576': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/576.webp',
                '768': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/768.webp',
                '960': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/960.webp',
                '1152': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/1152.webp',
                '1344': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/1344.webp',
                '1536': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/1536.webp',
                '1728': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/1728.webp',
                '1920': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/1920.webp',
                default: 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/1920.jpeg'
            },
            mime_type: 'image/jpeg',
            category_id: '1f0ca0db-d0fa-4b03-9703-9f152615ed0c',
            size_in_bytes: 203024,
            tags: [],
            metadata: { 
                description: 'An image of a cupcake', 
                custom_attributes: {}
            }
        },
        user: { id: 'user-1', role: 'User' }
    },
    sent_at: '2024-02-18T18:32:22.689Z'
}

# 资产缓存失效

名称：asset.cache.invalidated
说明：当资产缓存应失效时触发。

# 有效负载

• workspace_id – 初始化操作的工作区标识符。
• asset – 覆盖的资产的详细信息。
• user – 执行此操作的用户的详细信息。
• paths_to_be_invalidated – 应失效的 URL 路径列表。

# 示例

以下示例显示了资产内容更改后发送的 webhook 请求，CDN 路径应失效。

{
    environment_id: '6afdca1ba1e38969dea1',
    event: 'asset.overwritten',
    payload: {
        workspace_id: '80e839331c4d8827c474',
        asset: {
            id: '_DpyO7eRxHtT',
            name: 'Cupcake',
            extension: 'jpeg',
            url: 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/file',
            images_urls: {
                '192': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/192.webp',
                '384': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/384.webp',
                '576': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/576.webp',
                '768': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/768.webp',
                '960': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/960.webp',
                '1152': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/1152.webp',
                '1344': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/1344.webp',
                '1536': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/1536.webp',
                '1728': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/1728.webp',
                '1920': 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/1920.webp',
                default: 'https://ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/1920.jpeg'
            },
            mime_type: 'image/jpeg',
            category_id: '1f0ca0db-d0fa-4b03-9703-9f152615ed0c',
            size_in_bytes: 203024,
            tags: [],
            metadata: { 
                description: 'An image of a cupcake', 
                custom_attributes: {}
            }
        },
        paths_to_be_invalidated: ['https://cdn.ckbox.dev/6afdca1ba1e38969dea1/assets/_DpyO7eRxHtT/images/192.webp']
        user: { id: 'user-1', role: 'User' }
    },
    sent_at: '2024-02-18T18:32:22.689Z'
}

# 文件夹

以下事件可以为 CKBox 中的文件夹触发。

# 文件夹创建

名称：folder.created
说明：当创建文件夹时触发。

# 有效负载

• workspace_id – 初始化操作的工作区标识符。
• folder – 创建的文件夹的详细信息。
• user – 执行此操作的用户的详细信息

# 示例

以下示例显示了用户创建文件夹后发送的 webhook 请求。

{
    environment_id: '6afdca1ba1e38969dea1',
    event: 'folder.created',
    payload: {
        workspace_id: '80e839331c4d8827c474',
        folder: {
            id: 'hr8zl8N_8-un',
            name: 'Folder',
            category_id: '957165c8-bb91-4792-922d-72c572b5b12d'
        },
        user: { id: 'user-1', role: 'User' }
    },
    sent_at: '2024-02-18T18:41:37.953Z'
}

# 文件夹修改

名称：folder.modified
说明：当文件夹被修改时触发。

# 有效负载

• workspace_id – 初始化操作的工作区标识符。
• folder – 修改后的文件夹的详细信息。
• user – 执行此操作的用户的详细信息

# 示例

以下示例显示了用户修改文件夹后发送的 webhook 请求。

{
    environment_id: '6afdca1ba1e38969dea1',
    event: 'folder.modified',
    payload: {
        workspace_id: '80e839331c4d8827c474',
        folder: {
            id: 'hr8zl8N_8-un',
            name: 'Images',
            category_id: '957165c8-bb91-4792-922d-72c572b5b12d'
        },
        user: { id: 'user-1', role: 'User' }
    },
    sent_at: '2024-02-18T18:42:42.351Z'
}

# 文件夹删除

名称：folder.removed
说明：当文件夹被删除时触发。

# 有效负载

• workspace_id – 初始化操作的工作区标识符。
• folder – 删除的文件夹的详细信息。
• user – 执行此操作的用户的详细信息

# 示例

以下示例显示了用户删除文件夹后发送的 webhook 请求。

{
    environment_id: '6afdca1ba1e38969dea1',
    event: 'folder.removed',
    payload: {
        workspace_id: '80e839331c4d8827c474',
        folder: {
            id: 'hr8zl8N_8-un',
            name: 'Images',
            category_id: '957165c8-bb91-4792-922d-72c572b5b12d'
        },
        user: { id: 'user-1', role: 'User' }
    },
    sent_at: '2024-02-18T18:43:30.861Z'
}

# 下一步

• 了解如何管理 Webhooks.
• 阅读有关在专用文章中测试 Webhooks 的更多信息.
• 查看 CKBox 中可用的事件列表.