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 <token>形式のBearer認証。tokenは認証トークンです。

パスパラメータ

account_idstring必須

Frame.io またはアドビエンティティの識別子。通常は Frame.io の UUID です。ただし、アドビクラウドストレージ内に存在するアカウント、プロジェクト、フォルダー、ファイル、バージョンスタックの場合 (アカウントとプロジェクトが Workfront に接続されている場合に該当)、アドビが割り当てた ID が代わりに使用される場合もあります。これらの ID には「adobe:」がプレフィックスとして付加されています (例 : アカウントの場合は「adobe:<adobe_org_id>」、プロジェクトまたはフォルダーの場合は「adobe:<adobe_asset_id>」、ファイルアセットの場合は「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