Update webhook

PATCH

https://api.frame.io/v4/accounts/:account_id/webhooks/:webhook_id

PATCH

/v4/accounts/:account_id/webhooks/:webhook_id

1 from frameio import Frameio
2 
3 client = Frameio(
4     base_url="https://api.frame.io"
5 )
6 
7 client.webhooks.update(
8     account_id="668dbdf8-e0d1-4585-b40d-48276461ad80",
9     webhook_id="0aa4c187-4c64-4380-b40b-7bb15e394fab",
10     data={
11         "active": True,
12         "events": [
13             "file.created",
14             "file.deleted",
15             "file.ready",
16             "file.updated",
17             "file.upload.completed",
18             "file.versioned",
19             "file.copied",
20             "folder.created",
21             "folder.deleted",
22             "folder.updated",
23             "folder.copied",
24             "comment.completed",
25             "comment.created",
26             "comment.deleted",
27             "comment.uncompleted",
28             "comment.updated",
29             "customfield.created",
30             "customfield.updated",
31             "customfield.deleted",
32             "metadata.value.updated",
33             "project.created",
34             "project.deleted",
35             "project.updated",
36             "collection.created",
37             "collection.updated",
38             "collection.deleted",
39             "share.created",
40             "share.updated",
41             "share.deleted",
42             "share.viewed"
43         ],
44         "name": "Updated Webhook",
45         "url": "https://url.example.com"
46     }
47 )

Try it

200Updated

1 {
2   "data": {
3     "created_at": "2024-02-12T21:34:58.501275Z",
4     "events": [
5       "file.created",
6       "file.deleted",
7       "file.ready",
8       "file.updated",
9       "file.upload.completed",
10       "file.versioned",
11       "file.copied",
12       "folder.created",
13       "folder.deleted",
14       "folder.updated",
15       "folder.copied",
16       "comment.completed",
17       "comment.created",
18       "comment.deleted",
19       "comment.uncompleted",
20       "comment.updated",
21       "customfield.created",
22       "customfield.updated",
23       "customfield.deleted",
24       "metadata.value.updated",
25       "project.created",
26       "project.deleted",
27       "project.updated",
28       "collection.created",
29       "collection.updated",
30       "collection.deleted",
31       "share.created",
32       "share.updated",
33       "share.deleted",
34       "share.viewed"
35     ],
36     "id": "fce84d5a-6b52-48a9-bb26-f6e988049f7c",
37     "name": "My First Webhook",
38     "updated_at": "2024-02-12T21:34:58.501275Z",
39     "url": "https://my.webhook.url.dev",
40     "active": true,
41     "workspace_id": "3a03fad5-7516-4a5c-a159-86b648085b20"
42   }
43 }

Update webhook details.

Rate Limits: 10 calls per 1.00 minute(s) per account

Path parameters

account_idstringRequiredformat: "uuid"

A UUID String

webhook_idstringRequiredformat: "uuid"

A UUID String

Request

Webhook params

dataobjectRequired

Response

dataobject

Path parameters

Request

Response

Errors