> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developer.staging.frame.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.staging.frame.io/_mcp/server. # Create webhook POST https://api.frame.io/v4/accounts/{account_id}/workspaces/{workspace_id}/webhooks Content-Type: application/json Creates a single webhook with secret.Valid 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.viewedRate Limits: 10 calls per 1.00 minute(s) per account Reference: https://developer.staging.frame.io/platform/api-reference/webhooks/create ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Path parameters - `account_id` (string, required) - `workspace_id` (string, required) ### Body (application/json) This endpoint expects a WebhookCreateParams. - `data` (WebhookCreateParamsData, required) ## Response ### 201 Created - `data` (WebhookCreateResponseData, required) ## Errors ### 400 Bad Request Error Bad Request - `errors` (list of BadRequestErrorsItems, required) ### 401 Unauthorized Error Unauthorized - `errors` (list of UnauthorizedErrorsItems, required) ### 403 Forbidden Error Forbidden - `errors` (list of ForbiddenErrorsItems, required) ### 404 Not Found Error Not Found - `errors` (list of NotFoundErrorsItems, required) ### 422 Unprocessable Entity Error Unprocessable Entity - `errors` (list of UnprocessableEntityErrorsItems, required) ### 429 Too Many Requests Error Too Many Requests - `errors` (list of TooManyRequestsErrorsItems, required) ## Types ### WebhookCreateParamsData - `events` (list of string, required) - `name` (string, required) - `url` (string, required) — URL where `event` is sent ### WebhookCreateResponseData - `created_at` (string, required) - `events` (list of string, required) - `id` (string, required) — Webhook ID - `name` (string, required) — Webhook Name - `secret` (string, required) — Secret used to validate webhook requests. Make sure to store your secret. You won’t be able to see it again! - `updated_at` (string, required) - `url` (string, required) - `active` (boolean, optional) — Webhook active status - `workspace_id` (string, optional, nullable) — Workspace ID ### BadRequestErrorsItems - `detail` (string, required) - `source` (BadRequestErrorsItemsSource, optional) - `title` (string, optional) ### UnauthorizedErrorsItems - `detail` (string, required) - `source` (UnauthorizedErrorsItemsSource, optional) - `title` (string, optional) ### ForbiddenErrorsItems - `detail` (string, required) - `source` (ForbiddenErrorsItemsSource, optional) - `title` (string, optional) ### NotFoundErrorsItems - `detail` (string, required) - `source` (NotFoundErrorsItemsSource, optional) - `title` (string, optional) ### UnprocessableEntityErrorsItems - `detail` (string, required) - `source` (UnprocessableEntityErrorsItemsSource, optional) - `title` (string, optional) ### TooManyRequestsErrorsItems - `detail` (string, required) - `source` (TooManyRequestsErrorsItemsSource, optional) - `title` (string, optional) ### BadRequestErrorsItemsSource - `pointer` (string, optional) ### UnauthorizedErrorsItemsSource - `pointer` (string, optional) ### ForbiddenErrorsItemsSource - `pointer` (string, optional) ### NotFoundErrorsItemsSource - `pointer` (string, optional) ### UnprocessableEntityErrorsItemsSource - `pointer` (string, optional) ### TooManyRequestsErrorsItemsSource - `pointer` (string, optional) ## Examples **Request** ```json { "data": { "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" ], "name": "New Webhook", "url": "https://url.example.com" } } ``` **Response** ```json { "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": "9b453544-e61d-4254-86eb-eeaf17c1c731", "name": "My First Webhook", "secret": "", "updated_at": "2024-02-12T21:34:58.501275Z", "url": "https://my.webhook.url.dev", "active": "true", "workspace_id": "a0750b26-8090-4ad5-b4b8-2943793d0871" } } ``` **SDK Code** ```python import requests url = "https://api.frame.io/v4/accounts/281524b6-b2f8-488d-aa4f-019ce42a70aa/workspaces/a7cb608d-d7b0-45f9-a4be-02f63aa662a1/webhooks" payload = { "data": { "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"], "name": "New Webhook", "url": "https://url.example.com" } } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.frame.io/v4/accounts/281524b6-b2f8-488d-aa4f-019ce42a70aa/workspaces/a7cb608d-d7b0-45f9-a4be-02f63aa662a1/webhooks'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"data":{"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"],"name":"New Webhook","url":"https://url.example.com"}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.frame.io/v4/accounts/281524b6-b2f8-488d-aa4f-019ce42a70aa/workspaces/a7cb608d-d7b0-45f9-a4be-02f63aa662a1/webhooks" payload := strings.NewReader("{\n \"data\": {\n \"events\": [\n \"file.created\",\n \"file.deleted\",\n \"file.ready\",\n \"file.updated\",\n \"file.upload.completed\",\n \"file.versioned\",\n \"file.copied\",\n \"folder.created\",\n \"folder.deleted\",\n \"folder.updated\",\n \"folder.copied\",\n \"comment.completed\",\n \"comment.created\",\n \"comment.deleted\",\n \"comment.uncompleted\",\n \"comment.updated\",\n \"customfield.created\",\n \"customfield.updated\",\n \"customfield.deleted\",\n \"metadata.value.updated\",\n \"project.created\",\n \"project.deleted\",\n \"project.updated\",\n \"collection.created\",\n \"collection.updated\",\n \"collection.deleted\",\n \"share.created\",\n \"share.updated\",\n \"share.deleted\",\n \"share.viewed\"\n ],\n \"name\": \"New Webhook\",\n \"url\": \"https://url.example.com\"\n }\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.frame.io/v4/accounts/281524b6-b2f8-488d-aa4f-019ce42a70aa/workspaces/a7cb608d-d7b0-45f9-a4be-02f63aa662a1/webhooks") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"data\": {\n \"events\": [\n \"file.created\",\n \"file.deleted\",\n \"file.ready\",\n \"file.updated\",\n \"file.upload.completed\",\n \"file.versioned\",\n \"file.copied\",\n \"folder.created\",\n \"folder.deleted\",\n \"folder.updated\",\n \"folder.copied\",\n \"comment.completed\",\n \"comment.created\",\n \"comment.deleted\",\n \"comment.uncompleted\",\n \"comment.updated\",\n \"customfield.created\",\n \"customfield.updated\",\n \"customfield.deleted\",\n \"metadata.value.updated\",\n \"project.created\",\n \"project.deleted\",\n \"project.updated\",\n \"collection.created\",\n \"collection.updated\",\n \"collection.deleted\",\n \"share.created\",\n \"share.updated\",\n \"share.deleted\",\n \"share.viewed\"\n ],\n \"name\": \"New Webhook\",\n \"url\": \"https://url.example.com\"\n }\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.frame.io/v4/accounts/281524b6-b2f8-488d-aa4f-019ce42a70aa/workspaces/a7cb608d-d7b0-45f9-a4be-02f63aa662a1/webhooks") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"data\": {\n \"events\": [\n \"file.created\",\n \"file.deleted\",\n \"file.ready\",\n \"file.updated\",\n \"file.upload.completed\",\n \"file.versioned\",\n \"file.copied\",\n \"folder.created\",\n \"folder.deleted\",\n \"folder.updated\",\n \"folder.copied\",\n \"comment.completed\",\n \"comment.created\",\n \"comment.deleted\",\n \"comment.uncompleted\",\n \"comment.updated\",\n \"customfield.created\",\n \"customfield.updated\",\n \"customfield.deleted\",\n \"metadata.value.updated\",\n \"project.created\",\n \"project.deleted\",\n \"project.updated\",\n \"collection.created\",\n \"collection.updated\",\n \"collection.deleted\",\n \"share.created\",\n \"share.updated\",\n \"share.deleted\",\n \"share.viewed\"\n ],\n \"name\": \"New Webhook\",\n \"url\": \"https://url.example.com\"\n }\n}") .asString(); ``` ```php request('POST', 'https://api.frame.io/v4/accounts/281524b6-b2f8-488d-aa4f-019ce42a70aa/workspaces/a7cb608d-d7b0-45f9-a4be-02f63aa662a1/webhooks', [ 'body' => '{ "data": { "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" ], "name": "New Webhook", "url": "https://url.example.com" } }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.frame.io/v4/accounts/281524b6-b2f8-488d-aa4f-019ce42a70aa/workspaces/a7cb608d-d7b0-45f9-a4be-02f63aa662a1/webhooks"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"data\": {\n \"events\": [\n \"file.created\",\n \"file.deleted\",\n \"file.ready\",\n \"file.updated\",\n \"file.upload.completed\",\n \"file.versioned\",\n \"file.copied\",\n \"folder.created\",\n \"folder.deleted\",\n \"folder.updated\",\n \"folder.copied\",\n \"comment.completed\",\n \"comment.created\",\n \"comment.deleted\",\n \"comment.uncompleted\",\n \"comment.updated\",\n \"customfield.created\",\n \"customfield.updated\",\n \"customfield.deleted\",\n \"metadata.value.updated\",\n \"project.created\",\n \"project.deleted\",\n \"project.updated\",\n \"collection.created\",\n \"collection.updated\",\n \"collection.deleted\",\n \"share.created\",\n \"share.updated\",\n \"share.deleted\",\n \"share.viewed\"\n ],\n \"name\": \"New Webhook\",\n \"url\": \"https://url.example.com\"\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["data": [ "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"], "name": "New Webhook", "url": "https://url.example.com" ]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.frame.io/v4/accounts/281524b6-b2f8-488d-aa4f-019ce42a70aa/workspaces/a7cb608d-d7b0-45f9-a4be-02f63aa662a1/webhooks")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```