Webhook aktualisieren | Frame.io API Documentation

from frameio import Frameio
from frameio.webhooks import WebhookUpdateParamsData
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.webhooks.update(
    account_id="2696262f-4a9a-49d5-82e8-056a61fa82fd",
    webhook_id="6bca70e2-0044-4a3e-a6de-0b5b4c7fd8a3",
    data=WebhookUpdateParamsData(
        active=True,
        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="Updated 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",
    "active": true,
    "workspace_id": "fead9ab7-6ef2-4db5-9530-4eeb2ec2d345"
  }
}

Webhook-Details aktualisieren.
Rate-Limits: 10 Aufrufe pro 1,00 Minute(n) pro account_user

Authentifizierung

AuthorizationBearer

Bearer-Authentifizierung der Form Bearer <token>, wobei token Ihr Auth-Token ist.

Pfadparameter

account_idstringErforderlich

Eine Frame.io- oder Adobe-Entitäts-ID. Normalerweise eine Frame.io-UUID. Für Konten, Projekte, Ordner, Dateien und Versionsstapel, die sich im Adobe Cloud-Speicher befinden (was bei Workfront-verbundenen Konten und -Projekten der Fall ist), kann aber auch eine von Adobe vergebene ID verwendet werden. Diese IDs müssen das Präfix ‘adobe:’ haben (z. B. ‘adobe:<adobe_org_id>’ für ein Konto, ‘adobe:<adobe_asset_id>’ für ein Projekt oder einen Ordner, ‘adobe:<adobe_asset_id>|<version>’ für ein Datei-Asset).

Eine Frame.io- oder Adobe-Entitäts-ID. Normalerweise eine Frame.io-UUID. Für Konten, Projekte, Ordner, Dateien und Versionsstapel, die sich im Adobe Cloud-Speicher befinden (was bei Workfront-verbundenen Konten und -Projekten der Fall ist), kann aber auch eine von Adobe vergebene ID verwendet werden. Diese IDs müssen das Präfix 'adobe:' haben (z. B. 'adobe:<adobe_org_id>' für ein Konto, 'adobe:<adobe_asset_id>' für ein Projekt oder einen Ordner, 'adobe:<adobe_asset_id>|<version>' für ein Datei-Asset).

webhook_idstringErforderlichFormat: "uuid"

Eine UUID-Zeichenfolge, die eine Frame.io-Entität eindeutig identifiziert.

Anfrage

Webhook-Parameter

dataobjectErforderlich

Antwort-Header

x-ratelimit-limitinteger

Rate-Limit

x-ratelimit-remaininginteger

Verbleibendes Rate-Limit

x-ratelimit-windowinteger

Rate-Limit-Fenster in Millisekunden

Antwort

dataobject

Fehler

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