Get Webhooks for Account

GET

https://api.frame.io/v2/accounts/:account_id/hooks

GET

/v2/accounts/:account_id/hooks

1 import requests
2 
3 url = "https://api.frame.io/v2/accounts/account_id/hooks"
4 
5 response = requests.get(url)
6 
7 print(response.json())

1 [
2   {
3     "account_id": "string",
4     "active": true,
5     "app_id": "string",
6     "deleted_at": "2024-01-15T09:30:00Z",
7     "events": [
8       "project.created"
9     ],
10     "id": "string",
11     "inserted_at": "2024-01-15T09:30:00Z",
12     "name": "string",
13     "project_id": "string",
14     "secret": "string",
15     "team": {
16       "account_id": "string",
17       "disable_sbwm_internally": false,
18       "creator_id": "string",
19       "storage": 0,
20       "default_font_color": "string",
21       "access": "private",
22       "font_color": "string",
23       "user_role": {},
24       "file_count": 0,
25       "default_session_watermark_template": {
26         "account_id": "string",
27         "app_default": false,
28         "creator_id": "string",
29         "id": "string",
30         "name": "string",
31         "watermark_blocks": [
32           {
33             "alpha": 0.5,
34             "data_points": [
35               {
36                 "order": 1,
37                 "type": "email",
38                 "value": "string"
39               }
40             ],
41             "font_size": "medium",
42             "name": "string",
43             "position": "top_left",
44             "position_reference_point": "top_left",
45             "position_x": 1,
46             "position_y": 1,
47             "scroll_text": "none",
48             "text_alignment": "left",
49             "text_color": "#FFFFFF",
50             "text_shadow": false
51           }
52         ]
53       },
54       "link": "string",
55       "asset_lifecycle_policy": 1,
56       "upload_url": "string",
57       "admin_only_actions": {
58         "lifecycle": false
59       },
60       "deleted_at": "2024-01-15T09:30:00Z",
61       "default_background_color": "string",
62       "storage_limit": 1,
63       "location": "string",
64       "name": "string",
65       "default_color": "string",
66       "slack_webhook": {},
67       "image_64": "string",
68       "archived_storage": 0,
69       "image_128": "string",
70       "solo": false,
71       "account": {
72         "invoice_emails": [
73           "string"
74         ],
75         "city": "string",
76         "account_default_color": "string",
77         "company_name": "string",
78         "storage": 1,
79         "file_count": 1,
80         "owner": {
81           "digest_frequency": "string",
82           "image_32": "string",
83           "image_128": "string",
84           "from_google": true,
85           "mfa_enforced_at": "string",
86           "email": "string",
87           "name": "string",
88           "image_64": "string",
89           "timezone_value": "string",
90           "account_id": "string",
91           "updated_at": "string",
92           "image_256": "string",
93           "_type": "string",
94           "user_hash": "string",
95           "upload_url": "string",
96           "profile_image": "string",
97           "first_login_at": "string",
98           "joined_via": "string",
99           "id": "string",
100           "next_digest_date": "string",
101           "last_seen": "string",
102           "inserted_at": "string",
103           "roles": {
104             "admin": true,
105             "id": "string",
106             "sales": true,
107             "support": true
108           },
109           "user_default_color": "string"
110         },
111         "upload_url": "string",
112         "deleted_at": "2024-01-15T09:30:00Z",
113         "line1": "string",
114         "postal_code": "string",
115         "vat": "string",
116         "company_address": "string",
117         "lifetime_file_count": 1,
118         "state": "string",
119         "teams": [
120           null
121         ],
122         "image_64": "string",
123         "archived_storage": 1,
124         "image_128": "string",
125         "owner_id": "string",
126         "user_count": 1,
127         "locked_at": "2024-01-15T09:30:00Z",
128         "image": "string",
129         "team_count": 1,
130         "collaborator_role_count": 1,
131         "billing_emails": "string",
132         "image_32": "string",
133         "unpaid_at": "2024-01-15T09:30:00Z",
134         "inserted_at": "2024-01-15T09:30:00Z",
135         "updated_at": "2024-01-15T09:30:00Z",
136         "project_count": 1,
137         "duration": 1,
138         "delinquent_at": "2024-01-15T09:30:00Z",
139         "collaborator_count": 1,
140         "plan": {
141           "archived_storage_limit": 1,
142           "autoscaling": true,
143           "available_features": {
144             "archival_storage": true,
145             "custom_branded_emails": true,
146             "custom_branded_presentations": true,
147             "reel_player": true,
148             "secure_sharing": true,
149             "session_based_watermarking": true,
150             "team_only_comments": true
151           },
152           "collaborator_limit": 1,
153           "cost": 1,
154           "default_plan": true,
155           "deleted_at": "2024-01-15T09:30:00Z",
156           "enterprise": true,
157           "file_limit": 1,
158           "id": "string",
159           "inserted_at": "2024-01-15T09:30:00Z",
160           "lifetime_file_limit": 1,
161           "member_limit": 1,
162           "name": "string",
163           "payment_method": "stripe",
164           "period": "monthly",
165           "project_limit": 1,
166           "storage_limit": 1,
167           "team_limit": 1,
168           "tier": "free",
169           "title": "string",
170           "updated_at": "2024-01-15T09:30:00Z",
171           "user_limit": 1,
172           "user_max": 1,
173           "version": 1
174         },
175         "watermark": {
176           "image": {
177             "alpha": 0.5,
178             "image": {
179               "bucket": "string",
180               "key": "string",
181               "type": "image/jpeg",
182               "uploaded": false
183             },
184             "position": "top_left"
185           },
186           "text": {
187             "alpha": 0.5,
188             "lines": [
189               "string"
190             ],
191             "position": "top"
192           }
193         },
194         "folder_count": 1,
195         "id": "string",
196         "display_name": "string",
197         "country": "string",
198         "subscription": {
199           "account_id": "string",
200           "archived_storage_limit": 1,
201           "balance": 1,
202           "cancellation_option": "string",
203           "cancellation_reason": "string",
204           "cancelled_at": "2024-01-15T09:30:00Z",
205           "deleted_at": "2024-01-15T09:30:00Z",
206           "id": "string",
207           "inserted_at": "2024-01-15T09:30:00Z",
208           "last_payment_at": "2024-01-15T09:30:00Z",
209           "member_limit": 1,
210           "next_bill_at": "2024-01-15T09:30:00Z",
211           "on_trial": true,
212           "plan": {
213             "archived_storage_limit": 1,
214             "autoscaling": true,
215             "available_features": {
216               "archival_storage": true,
217               "custom_branded_emails": true,
218               "custom_branded_presentations": true,
219               "reel_player": true,
220               "secure_sharing": true,
221               "session_based_watermarking": true,
222               "team_only_comments": true
223             },
224             "collaborator_limit": 1,
225             "cost": 1,
226             "default_plan": true,
227             "deleted_at": "2024-01-15T09:30:00Z",
228             "enterprise": true,
229             "file_limit": 1,
230             "id": "string",
231             "inserted_at": "2024-01-15T09:30:00Z",
232             "lifetime_file_limit": 1,
233             "member_limit": 1,
234             "name": "string",
235             "payment_method": "stripe",
236             "period": "monthly",
237             "project_limit": 1,
238             "storage_limit": 1,
239             "team_limit": 1,
240             "tier": "free",
241             "title": "string",
242             "updated_at": "2024-01-15T09:30:00Z",
243             "user_limit": 1,
244             "user_max": 1,
245             "version": 1
246           },
247           "plan_id": "string",
248           "promotion_expires_at": "2024-01-15T09:30:00Z",
249           "promotion_id": "string",
250           "requires_autoscaling": true,
251           "storage_limit": 1,
252           "subscription_end_at": "2024-01-15T09:30:00Z",
253           "total_archived_storage_limit": 1,
254           "total_lifetime_file_limit": 1,
255           "total_member_limit": 1,
256           "total_project_limit": 1,
257           "total_storage_limit": 1,
258           "total_user_limit": 1,
259           "updated_at": "2024-01-15T09:30:00Z",
260           "user_limit": 1
261         },
262         "account_members": [
263           {
264             "accepted_at": "2024-01-15T09:30:00Z",
265             "account_id": "string",
266             "declined_at": "2024-01-15T09:30:00Z",
267             "deleted_at": "2024-01-15T09:30:00Z",
268             "inserted_at": "2024-01-15T09:30:00Z",
269             "role": "admin",
270             "updated_at": "2024-01-15T09:30:00Z",
271             "user_id": "string"
272           }
273         ],
274         "frames": 1,
275         "member_count": 1,
276         "image_256": "string"
277       },
278       "image_32": "string",
279       "inserted_at": "2024-01-15T09:30:00Z",
280       "updated_at": "2024-01-15T09:30:00Z",
281       "project_count": 0,
282       "duration": 0,
283       "team_image": "string",
284       "collaborator_count": 0,
285       "bio": "string",
286       "color": "string",
287       "email_branding": {
288         "accent_color": "string",
289         "background_color": "string",
290         "image": {
291           "bucket": "string",
292           "key": "string",
293           "type": "image/jpeg",
294           "uploaded": false
295         }
296       },
297       "folder_count": 0,
298       "dark_theme": false,
299       "default_session_watermark_template_id": "string",
300       "session_watermark_templates": [
301         {
302           "account_id": "string",
303           "app_default": false,
304           "creator_id": "string",
305           "id": "string",
306           "name": "string",
307           "watermark_blocks": [
308             {
309               "alpha": 0.5,
310               "data_points": [
311                 {
312                   "order": 1,
313                   "type": "email",
314                   "value": "string"
315                 }
316               ],
317               "font_size": "medium",
318               "name": "string",
319               "position": "top_left",
320               "position_reference_point": "top_left",
321               "position_x": 1,
322               "position_y": 1,
323               "scroll_text": "none",
324               "text_alignment": "left",
325               "text_color": "#FFFFFF",
326               "text_shadow": false
327             }
328           ]
329         }
330       ],
331       "id": "string",
332       "member_limit": 1,
333       "frames": 0,
334       "member_count": 0,
335       "image_256": "string",
336       "background_color": "string"
337     },
338     "team_id": "string",
339     "updated_at": "2024-01-15T09:30:00Z",
340     "url": "string"
341   }
342 ]

Get Webhooks belonging to a given Account

Path parameters

account_idstringRequiredformat: "uuid"

Response

Webhook success response

account_idstringformat: "uuid"

activeboolean

app_idstringformat: "uuid"

deleted_atstringformat: "date-time"

eventslist of enums

idstringformat: "uuid"

inserted_atstringformat: "date-time"

namestring

project_idstringformat: "uuid"

secretstring

teamobject

team_idstringformat: "uuid"

updated_atstringformat: "date-time"

urlstring

Errors

401

Unauthorized Error

404

Not Found Error