Webhooks auflisten | Frame.io API Documentation

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.webhooks.index(
    account_id="2aba5bd8-3f0d-44a9-be8d-a8fba329dd98",
    workspace_id="a669b52b-f72e-4ea2-a11a-e2bb248392a2",
)

{
  "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",
      "creator": {
        "active": true,
        "avatar_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN",
        "email": "user_email@example.com",
        "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e",
        "name": "Jon Doe"
      }
    }
  ],
  "links": {
    "next": "/v4/accounts/123/workspaces/123/webhooks"
  },
  "total_count": 10
}

Webhooks für den angegebenen Arbeitsbereich auflisten.
Rate-Limits: 100 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).

workspace_idstringErforderlichFormat: "uuid"

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

Abfrageparameter

includeenumOptional

Abfrageparameter für Webhooks einschließen

Erlaubte Werte:

afterstringOptional

Undurchsichtiger Cursor-Abfrageparameter für Anfragen, die paginierte Ergebnisse zurückgeben.

HINWEIS: Dieser Wert wird automatisch generiert und als Teil von Links aus einer vorherigen Antwort eingefügt. Er ist nicht dafür vorgesehen, für Menschen lesbar zu sein.

page_sizeintegerOptional1-100Standardwert ist 50

Seitengröße-Abfrageparameter für Anfragen

include_total_countbooleanOptionalStandardwert ist false

Seiten-Abfrageparameter zum Einbeziehen der Anzahl aller Entitäten

Antwort-Header

x-ratelimit-limitinteger

Rate-Limit

x-ratelimit-remaininginteger

Verbleibendes Rate-Limit

x-ratelimit-windowinteger

Rate-Limit-Fenster in Millisekunden

Antwort

datalist of objects

linksobject

Links zu paginierten Daten

total_countinteger or nullOptional

Gesamtanzahl

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