Crear 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"
  }
}

Crea un solo webhook con secreto.

Eventos válidos:

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

.
Límites de frecuencia: 10 llamadas por 1,00 minutos por account_user

Crea un solo webhook con secreto. Eventos válidos:<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> . Límites de frecuencia: 10 llamadas por 1,00 minutos por account_user

Autenticación

AuthorizationBearer

Autenticación de portador de la forma Bearer <token>, donde token es tu token de autenticación.

Parámetros de ruta

account_idstringRequerido

Un identificador de entidad de Frame.io o Adobe. Normalmente, un UUID de Frame.io. Sin embargo, para cuentas, proyectos, carpetas, archivos y pilas de versiones que residen en el almacenamiento en la nube de Adobe, lo que ocurre en el caso de cuentas y proyectos conectados con Workfront, también se puede usar indistintamente un id asignado por Adobe. Estos id deben llevar el prefijo adobe: (por ejemplo, adobe:<adobe_org_id>para una cuenta,adobe:<adobe_asset_id>para un proyecto o una carpeta,adobe:adobe:<adobe_asset_id>|<version> para un activo de archivo).

Un identificador de entidad de Frame.io o Adobe. Normalmente, un UUID de Frame.io. Sin embargo, para cuentas, proyectos, carpetas, archivos y pilas de versiones que residen en el almacenamiento en la nube de Adobe, lo que ocurre en el caso de cuentas y proyectos conectados con Workfront, también se puede usar indistintamente un id asignado por Adobe. Estos id deben llevar el prefijo `adobe:` (por ejemplo, adobe:<adobe_org_id>` para una cuenta, `adobe:<adobe_asset_id>` para un proyecto o una carpeta, `adobe:`adobe:<adobe_asset_id>|<version>` para un activo de archivo).

workspace_idstringRequeridoformat: "uuid"

Una cadena de UUID que identifica de forma única una entidad de Frame.io.

Solicitud

Parámetros de webhook

dataobjectRequerido

Encabezados de respuesta

x-ratelimit-limitinteger

Límite de frecuencia

x-ratelimit-remaininginteger

Límite de frecuencia restante

x-ratelimit-windowinteger

Periodo de límite de frecuencia en milisegundos

Respuesta

Creado

dataobject

Errores

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