List webhooks | Frame.io API Documentation

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.webhooks.index(
    account_id="92bb2b6e-6201-4db6-9841-1359c80b5951",
    workspace_id="aeef76c2-969e-4f7a-9b8d-e7ec1d74a9e4",
)

{
  "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": "73d9be37-6db7-4bb9-955e-753b1fe675da",
      "name": "My First Webhook",
      "updated_at": "2024-02-12T21:34:58.501275Z",
      "url": "https://my.webhook.url.dev",
      "active": "true",
      "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"
      },
      "workspace_id": "c79b5a62-2998-478b-b31a-b3422b38e3d9"
    }
  ],
  "links": {
    "next": "/v4/accounts/123/workspaces/123/webhooks"
  },
  "total_count": 10
}

List webhooks for the given workspace.
Rate Limits: 100 calls per 1.00 minute(s) per account_user

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequiredformat: "uuid"

A UUID String

workspace_idstringRequiredformat: "uuid"

A UUID String

Query parameters

includeenumOptional

Include query parameter for webhooks

Allowed values:

afterstringOptional

Opaque Cursor query param for requests returning paginated results.

NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.

page_sizeintegerOptional1-100Defaults to 50

Page size query param for requests

include_total_countbooleanOptionalDefaults to false

Page query param to include the count of all entities

Response headers

x-ratelimit-limitinteger

Rate limit

x-ratelimit-remaininginteger

Rate limit remaining

x-ratelimit-windowinteger

Rate limit window in milliseconds

Response

datalist of objects

linksobject

Links to paginated data

total_countinteger or null

Total count

Errors

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