Créer un 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="105050ae-eb65-4916-8be7-de40af3321d5",
    workspace_id="55c1a978-8d90-4461-b43e-4d485a37040b",
    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": "991a0ceb-46a1-4d70-a8da-29890dd67774",
    "name": "My First Webhook",
    "updated_at": "2024-02-12T21:34:58.501275Z",
    "url": "https://my.webhook.url.dev",
    "secret": "<secret>",
    "active": true,
    "workspace_id": "ecefeac3-60c4-4dfe-a492-6f2f4003f6e0"
  }
}

Creates a single webhook with secret.

Valid 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

.
Rate Limits: 10 calls per 1.00 minute(s) per account_user

Creates a single webhook with secret. Valid events:<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> . Rate Limits: 10 calls per 1.00 minute(s) per account_user

Authentification

AuthorizationBearer

Authentification bearer de la forme Bearer <token>, où token est votre jeton d’authentification.

Paramètres de chemin

account_idstringRequis

A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be prefixed with adobe: (e.g. adobe:<adobe_org_id> for an account, adobe:<adobe_asset_id> for a project or folder, adobe:adobe:<adobe_asset_id>|<version>` for a file asset).

A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be prefixed with `adobe:` (e.g. `adobe:<adobe_org_id>` for an account, `adobe:<adobe_asset_id>` for a project or folder, `adobe:`adobe:<adobe_asset_id>|<version>` for a file asset).

workspace_idstringRequisformat: "uuid"

A UUID string that uniquely identifies a Frame.io entity.

Requête

Webhook params

dataobjectRequis

En-têtes de réponse

x-ratelimit-limitinteger

Rate limit

x-ratelimit-remaininginteger

Rate limit remaining

x-ratelimit-windowinteger

Rate limit window in milliseconds

Réponse

Created

dataobject

Erreurs

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