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

Cria um único webhook com segredo.

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

.
Limites de taxa: 10 chamadas por 1,00 minuto por account_user

Cria um único webhook com segredo. 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> . Limites de taxa: 10 chamadas por 1,00 minuto por account_user

Autenticação

AuthorizationBearer

Autenticação bearer na forma Bearer <token>, onde token é seu token de autenticação.

Parâmetros de caminho

account_idstringObrigatório

Um identificador de entidade da Frame.io ou da Adobe. Normalmente, um UUID do Frame.io. Mas, no caso de contas, projetos, pastas, arquivos e pilhas de versões armazenados na nuvem da Adobe – como ocorre com contas e projetos conectados ao Workfront –, também é possível utilizar um ID atribuído pela Adobe de forma intercambiável. Esses IDs devem ser prefixados com adobe: (por exemplo, adobe:<adobe_org_id> para uma conta, adobe:<adobe_asset_id> para um projeto ou pasta e adobe:<adobe_asset_id>|<version> para um arquivo).

Um identificador de entidade da Frame.io ou da Adobe. Normalmente, um UUID do Frame.io. Mas, no caso de contas, projetos, pastas, arquivos e pilhas de versões armazenados na nuvem da Adobe – como ocorre com contas e projetos conectados ao Workfront –, também é possível utilizar um ID atribuído pela Adobe de forma intercambiável. Esses IDs devem ser prefixados com `adobe:` (por exemplo, `adobe:<adobe_org_id>` para uma conta, `adobe:<adobe_asset_id>` para um projeto ou pasta e `adobe:<adobe_asset_id>|<version>` para um arquivo).

workspace_idstringObrigatórioformat: "uuid"

Uma string UUID que identifica de forma exclusiva uma entidade do Frame.io.

Solicitação

Parâmetros do webhook

dataobjectObrigatório

Cabeçalhos de resposta

x-ratelimit-limitinteger

Limite de taxa

x-ratelimit-remaininginteger

Limite de taxa restante

x-ratelimit-windowinteger

Janela do limite de taxa em milissegundos

Resposta

Criado

dataobject

Erros

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