Get Webhook by ID

GET

https://api.frame.io/v2/hooks/:hook_id

GET

/v2/hooks/:hook_id

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

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

Get the information about a given Webhook

Path parameters

hook_idstringRequired

Response

Webhook success response

account_idstringOptionalformat: "uuid"

activebooleanOptional

app_idstringOptionalformat: "uuid"

deleted_atstringOptionalformat: "date-time"

eventslist of enumsOptional

idstringOptionalformat: "uuid"

inserted_atstringOptionalformat: "date-time"

namestringOptional

project_idstringOptionalformat: "uuid"

secretstringOptional

teamobjectOptional

team_idstringOptionalformat: "uuid"

updated_atstringOptionalformat: "date-time"

urlstringOptional

Errors

401

Unauthorized Error

404

Not Found Error