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 headers = {"Authorization": "Bearer <token>"}
6 
7 response = requests.get(url, headers=headers)
8 
9 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           "from_adobe": true,
104           "avatar_color": "string",
105           "highest_account_role": "string",
106           "integrations": [
107             "string"
108           ],
109           "roles": {
110             "admin": true,
111             "id": "string",
112             "sales": true,
113             "support": true,
114             "service_desk": true
115           },
116           "user_default_color": "string"
117         },
118         "upload_url": "string",
119         "deleted_at": "2024-01-15T09:30:00Z",
120         "line1": "string",
121         "postal_code": "string",
122         "vat": "string",
123         "company_address": "string",
124         "lifetime_file_count": 1,
125         "state": "string",
126         "teams": [
127           null
128         ],
129         "image_64": "string",
130         "archived_storage": 1,
131         "image_128": "string",
132         "owner_id": "string",
133         "user_count": 1,
134         "locked_at": "2024-01-15T09:30:00Z",
135         "image": "string",
136         "team_count": 1,
137         "collaborator_role_count": 1,
138         "billing_emails": "string",
139         "image_32": "string",
140         "unpaid_at": "2024-01-15T09:30:00Z",
141         "inserted_at": "2024-01-15T09:30:00Z",
142         "updated_at": "2024-01-15T09:30:00Z",
143         "project_count": 1,
144         "duration": 1,
145         "delinquent_at": "2024-01-15T09:30:00Z",
146         "collaborator_count": 1,
147         "plan": {
148           "archived_storage_limit": 1,
149           "autoscaling": true,
150           "available_features": {
151             "archival_storage": true,
152             "custom_branded_emails": true,
153             "custom_branded_presentations": true,
154             "reel_player": true,
155             "secure_sharing": true,
156             "session_based_watermarking": true,
157             "team_only_comments": true
158           },
159           "collaborator_limit": 1,
160           "cost": 1,
161           "default_plan": true,
162           "deleted_at": "2024-01-15T09:30:00Z",
163           "enterprise": true,
164           "file_limit": 1,
165           "id": "string",
166           "inserted_at": "2024-01-15T09:30:00Z",
167           "lifetime_file_limit": 1,
168           "member_limit": 1,
169           "name": "string",
170           "payment_method": "stripe",
171           "period": "monthly",
172           "project_limit": 1,
173           "storage_limit": 1,
174           "team_limit": 1,
175           "tier": "free",
176           "title": "string",
177           "updated_at": "2024-01-15T09:30:00Z",
178           "user_limit": 1,
179           "user_max": 1,
180           "version": 1
181         },
182         "watermark": {
183           "image": {
184             "alpha": 0.5,
185             "image": {
186               "bucket": "string",
187               "key": "string",
188               "type": "image/jpeg",
189               "uploaded": false
190             },
191             "position": "top_left"
192           },
193           "text": {
194             "alpha": 0.5,
195             "lines": [
196               "string"
197             ],
198             "position": "top"
199           }
200         },
201         "folder_count": 1,
202         "id": "string",
203         "display_name": "string",
204         "country": "string",
205         "subscription": {
206           "account_id": "string",
207           "archived_storage_limit": 1,
208           "balance": 1,
209           "cancellation_option": "string",
210           "cancellation_reason": "string",
211           "cancelled_at": "2024-01-15T09:30:00Z",
212           "deleted_at": "2024-01-15T09:30:00Z",
213           "id": "string",
214           "inserted_at": "2024-01-15T09:30:00Z",
215           "last_payment_at": "2024-01-15T09:30:00Z",
216           "member_limit": 1,
217           "next_bill_at": "2024-01-15T09:30:00Z",
218           "on_trial": true,
219           "plan": {
220             "archived_storage_limit": 1,
221             "autoscaling": true,
222             "available_features": {
223               "archival_storage": true,
224               "custom_branded_emails": true,
225               "custom_branded_presentations": true,
226               "reel_player": true,
227               "secure_sharing": true,
228               "session_based_watermarking": true,
229               "team_only_comments": true
230             },
231             "collaborator_limit": 1,
232             "cost": 1,
233             "default_plan": true,
234             "deleted_at": "2024-01-15T09:30:00Z",
235             "enterprise": true,
236             "file_limit": 1,
237             "id": "string",
238             "inserted_at": "2024-01-15T09:30:00Z",
239             "lifetime_file_limit": 1,
240             "member_limit": 1,
241             "name": "string",
242             "payment_method": "stripe",
243             "period": "monthly",
244             "project_limit": 1,
245             "storage_limit": 1,
246             "team_limit": 1,
247             "tier": "free",
248             "title": "string",
249             "updated_at": "2024-01-15T09:30:00Z",
250             "user_limit": 1,
251             "user_max": 1,
252             "version": 1
253           },
254           "plan_id": "string",
255           "promotion_expires_at": "2024-01-15T09:30:00Z",
256           "promotion_id": "string",
257           "requires_autoscaling": true,
258           "storage_limit": 1,
259           "subscription_end_at": "2024-01-15T09:30:00Z",
260           "total_archived_storage_limit": 1,
261           "total_lifetime_file_limit": 1,
262           "total_member_limit": 1,
263           "total_project_limit": 1,
264           "total_storage_limit": 1,
265           "total_user_limit": 1,
266           "updated_at": "2024-01-15T09:30:00Z",
267           "user_limit": 1
268         },
269         "account_members": [
270           {
271             "accepted_at": "2024-01-15T09:30:00Z",
272             "account_id": "string",
273             "declined_at": "2024-01-15T09:30:00Z",
274             "deleted_at": "2024-01-15T09:30:00Z",
275             "inserted_at": "2024-01-15T09:30:00Z",
276             "role": "admin",
277             "updated_at": "2024-01-15T09:30:00Z",
278             "user_id": "string"
279           }
280         ],
281         "frames": 1,
282         "member_count": 1,
283         "image_256": "string"
284       },
285       "image_32": "string",
286       "inserted_at": "2024-01-15T09:30:00Z",
287       "updated_at": "2024-01-15T09:30:00Z",
288       "project_count": 0,
289       "duration": 0,
290       "team_image": "string",
291       "collaborator_count": 0,
292       "bio": "string",
293       "color": "string",
294       "email_branding": {
295         "accent_color": "string",
296         "background_color": "string",
297         "image": {
298           "bucket": "string",
299           "key": "string",
300           "type": "image/jpeg",
301           "uploaded": false
302         }
303       },
304       "folder_count": 0,
305       "dark_theme": false,
306       "default_session_watermark_template_id": "string",
307       "session_watermark_templates": [
308         {
309           "account_id": "string",
310           "app_default": false,
311           "creator_id": "string",
312           "id": "string",
313           "name": "string",
314           "watermark_blocks": [
315             {
316               "alpha": 0.5,
317               "data_points": [
318                 {
319                   "order": 1,
320                   "type": "email",
321                   "value": "string"
322                 }
323               ],
324               "font_size": "medium",
325               "name": "string",
326               "position": "top_left",
327               "position_reference_point": "top_left",
328               "position_x": 1,
329               "position_y": 1,
330               "scroll_text": "none",
331               "text_alignment": "left",
332               "text_color": "#FFFFFF",
333               "text_shadow": false
334             }
335           ]
336         }
337       ],
338       "id": "string",
339       "member_limit": 1,
340       "frames": 0,
341       "member_count": 0,
342       "image_256": "string",
343       "background_color": "string"
344     },
345     "team_id": "string",
346     "updated_at": "2024-01-15T09:30:00Z",
347     "url": "string"
348   }
349 ]

Get Webhooks belonging to a given Account

Authentication

AuthorizationBearer

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

Path parameters

account_idstringRequiredformat: "uuid"

Response headers

linkstring

Pagination links

page-numberinteger

Current page of results

per-pageinteger

Number of entries per page

totalinteger

Total entries across all pagess

total-pagesinteger

Number of pages

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