创建 Webhook | Frame.io API Documentation

from frameio import Frameio
from frameio.webhooks import WebhookCreateParamsData
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.webhooks.create(
    account_id="3dc2a14f-51ff-4cff-8c85-9cc5572898ee",
    workspace_id="05793fae-e84c-413e-b4ee-f8b6a99ab911",
    data=WebhookCreateParamsData(
        events=[
            "file.created",
            "file.deleted",
            "file.ready",
            "file.updated",
            "file.upload.completed",
            "file.versioned",
            "file.copied",
            "folder.created",
            "folder.deleted",
            "folder.updated",
            "folder.copied",
            "comment.completed",
            "comment.created",
            "comment.deleted",
            "comment.uncompleted",
            "comment.updated",
            "customfield.created",
            "customfield.updated",
            "customfield.deleted",
            "metadata.value.updated",
            "project.created",
            "project.deleted",
            "project.updated",
            "collection.created",
            "collection.updated",
            "collection.deleted",
            "share.created",
            "share.updated",
            "share.deleted",
            "share.viewed"
        ],
        name="New Webhook",
        url="https://url.example.com",
    ),
)

{
  "data": {
    "created_at": "2024-02-12T21:34:58.501275Z",
    "events": [
      "file.created",
      "file.deleted",
      "file.ready",
      "file.updated",
      "file.upload.completed",
      "file.versioned",
      "file.copied",
      "folder.created",
      "folder.deleted",
      "folder.updated",
      "folder.copied",
      "comment.completed",
      "comment.created",
      "comment.deleted",
      "comment.uncompleted",
      "comment.updated",
      "customfield.created",
      "customfield.updated",
      "customfield.deleted",
      "metadata.value.updated",
      "project.created",
      "project.deleted",
      "project.updated",
      "collection.created",
      "collection.updated",
      "collection.deleted",
      "share.created",
      "share.updated",
      "share.deleted",
      "share.viewed"
    ],
    "id": "3fa96be3-f9de-4462-9028-16a6d8646c10",
    "name": "My First Webhook",
    "updated_at": "2024-02-12T21:34:58.501275Z",
    "url": "https://my.webhook.url.dev",
    "secret": "<secret>",
    "active": true,
    "workspace_id": "fead9ab7-6ef2-4db5-9530-4eeb2ec2d345"
  }
}

创建单个包含密钥的 Webhook。

有效事件：

file.created、file.deleted、file.ready、file.updated、file.upload.completed、file.versioned、file.copied、folder.created、folder.deleted、folder.updated、folder.copied、comment.completed、comment.created、comment.deleted、comment.uncompleted、comment.updated、customfield.created、customfield.updated、customfield.deleted、metadata.value.updated、project.created、project.deleted、project.updated、collection.created、collection.updated、collection.deleted、share.created、share.updated、share.deleted、share.viewed

速率限制：每个 account_user 每 1.00 分钟 10 次调用

创建单个包含密钥的 Webhook。 有效事件：<code> file.created、file.deleted、file.ready、file.updated、file.upload.completed、file.versioned、file.copied、folder.created、folder.deleted、folder.updated、folder.copied、comment.completed、comment.created、comment.deleted、comment.uncompleted、comment.updated、customfield.created、customfield.updated、customfield.deleted、metadata.value.updated、project.created、project.deleted、project.updated、collection.created、collection.updated、collection.deleted、share.created、share.updated、share.deleted、share.viewed </code> 速率限制：每个 account_user 每 1.00 分钟 10 次调用

身份验证

AuthorizationBearer

Bearer 身份验证，格式为 Bearer <token>，其中 token 是您的身份验证令牌。

路径参数

account_idstring必需

Frame.io 或 Adobe 实体标识符。通常为 Frame.io UUID。但对于位于 Adobe 云存储中的帐户、项目、文件夹、文件和版本堆栈（即 Workfront 关联的帐户和项目），也可以互换使用 Adobe 分配的 ID。这些 ID 必须以 adobe: 作为前缀（例如：帐户使用 adobe:<adobe_org_id>，项目或文件夹使用 adobe:<adobe_asset_id>，文件资产使用 adobe:adobe:<adobe_asset_id>|<version>`）。

Frame.io 或 Adobe 实体标识符。通常为 Frame.io UUID。但对于位于 Adobe 云存储中的帐户、项目、文件夹、文件和版本堆栈（即 Workfront 关联的帐户和项目），也可以互换使用 Adobe 分配的 ID。这些 ID 必须以 `adobe:` 作为前缀（例如：帐户使用 `adobe:<adobe_org_id>`，项目或文件夹使用 `adobe:<adobe_asset_id>`，文件资产使用 `adobe:`adobe:<adobe_asset_id>|<version>`）。

workspace_idstring必需格式: "uuid"

用于唯一标识 Frame.io 实体的 UUID 字符串。

请求

Webhook 参数

dataobject必需

响应头

x-ratelimit-limitinteger

速率限制

x-ratelimit-remaininginteger

剩余速率限制

x-ratelimit-windowinteger

速率限制时间窗口（以毫秒为单位）

响应

已创建

dataobject

错误

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error