[{"data":1,"prerenderedAt":904},["ShallowReactive",2],{"docs-\u002Fdocs\u002Fapi\u002Frender-webhooks":3,"docs-section-API":881},{"id":4,"title":5,"body":6,"description":872,"extension":873,"meta":874,"navigation":875,"order":97,"path":876,"section":877,"seo":878,"stem":879,"__hash__":880},"docs\u002Fdocs\u002Fapi\u002Frender-webhooks.md","Webhooks",{"type":7,"value":8,"toc":864},"minimark",[9,13,18,26,119,145,149,152,159,163,170,223,471,480,483,541,545,552,562,565,568,593,614,617,624,628,639,645,720,726,732,778,781,817,829,832,860],[10,11,12],"p",{},"A video takes a minute or two to make. Instead of asking again and again, give the render an address and we send you the result when it's done.",[14,15,17],"h2",{"id":16},"ask-to-be-told","Ask to be told",[10,19,20,21,25],{},"Add ",[22,23,24],"code",{},"webhook"," to the request that starts the render:",[27,28,33],"pre",{"className":29,"code":30,"language":31,"meta":32,"style":32},"language-bash shiki shiki-themes github-light github-dark","curl {{base}}\u002Frenders \\\n  -H \"Authorization: Bearer $API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"brand\": \"cm9x2brand0001\",\n    \"template\": \"quote-reel\",\n    \"modifications\": { \"quote\": \"Honest people.\", \"count\": 214, \"label\": \"happy clients\" },\n    \"webhook\": \"https:\u002F\u002Fexample.com\u002Frender-done?order=1042\"\n  }'\n","bash","",[22,34,35,52,70,80,89,95,101,107,113],{"__ignoreMap":32},[36,37,40,44,48],"span",{"class":38,"line":39},"line",1,[36,41,43],{"class":42},"sScJk","curl",[36,45,47],{"class":46},"sZZnC"," {{base}}\u002Frenders",[36,49,51],{"class":50},"sj4cs"," \\\n",[36,53,55,58,61,65,68],{"class":38,"line":54},2,[36,56,57],{"class":50},"  -H",[36,59,60],{"class":46}," \"Authorization: Bearer ",[36,62,64],{"class":63},"sVt8B","$API_KEY",[36,66,67],{"class":46},"\"",[36,69,51],{"class":50},[36,71,73,75,78],{"class":38,"line":72},3,[36,74,57],{"class":50},[36,76,77],{"class":46}," \"Content-Type: application\u002Fjson\"",[36,79,51],{"class":50},[36,81,83,86],{"class":38,"line":82},4,[36,84,85],{"class":50},"  -d",[36,87,88],{"class":46}," '{\n",[36,90,92],{"class":38,"line":91},5,[36,93,94],{"class":46},"    \"brand\": \"cm9x2brand0001\",\n",[36,96,98],{"class":38,"line":97},6,[36,99,100],{"class":46},"    \"template\": \"quote-reel\",\n",[36,102,104],{"class":38,"line":103},7,[36,105,106],{"class":46},"    \"modifications\": { \"quote\": \"Honest people.\", \"count\": 214, \"label\": \"happy clients\" },\n",[36,108,110],{"class":38,"line":109},8,[36,111,112],{"class":46},"    \"webhook\": \"https:\u002F\u002Fexample.com\u002Frender-done?order=1042\"\n",[36,114,116],{"class":38,"line":115},9,[36,117,118],{"class":46},"  }'\n",[120,121,122,134],"ul",{},[123,124,125,126,129,130,133],"li",{},"The address must start with ",[22,127,128],{},"https:\u002F\u002F"," and be a public website. We check it before anything starts or is charged, so a mistyped address is a ",[22,131,132],{},"400",", not a lost video.",[123,135,136,144],{},[137,138,139,140,143],"strong",{},"Anything after the ",[22,141,142],{},"?"," comes back to you."," Put your own reference there (a spreadsheet row, an order number) and you'll know which video it is. It can be up to 500 characters in all.",[14,146,148],{"id":147},"when-its-sent","When it's sent",[10,150,151],{},"We check renders that have a webhook about every 15 minutes, so you hear within about 15 minutes of the video being ready.",[10,153,154,155,158],{},"To hear sooner, also ask for the render with ",[22,156,157],{},"GET \u002Frenders\u002F{id}",". Any request for a render that has finished sends its webhook straight away. It is still sent only once, however you hear first.",[14,160,162],{"id":161},"what-we-send","What we send",[10,164,165,166,169],{},"A ",[22,167,168],{},"POST"," with a JSON body, one of two events:",[171,172,173,188],"table",{},[174,175,176],"thead",{},[177,178,179,185],"tr",{},[180,181,182],"th",{},[22,183,184],{},"type",[180,186,187],{},"When",[189,190,191,206],"tbody",{},[177,192,193,199],{},[194,195,196],"td",{},[22,197,198],{},"render.ready",[194,200,201,202,205],{},"The video is made and saved. ",[22,203,204],{},"data.url"," is the MP4.",[177,207,208,213],{},[194,209,210],{},[22,211,212],{},"render.failed",[194,214,215,216,218,219,222],{},"It couldn't be made. ",[22,217,204],{}," is ",[22,220,221],{},"null",", and nothing was charged.",[27,224,228],{"className":225,"code":226,"language":227,"meta":32,"style":32},"language-json shiki shiki-themes github-light github-dark","{\n  \"id\": \"cm9x2render001\",\n  \"type\": \"render.ready\",\n  \"created\": \"2026-10-29T18:01:12.000Z\",\n  \"business\": { \"id\": \"cm9x2brand0001\", \"name\": \"Main Street Bakery\" },\n  \"data\": {\n    \"id\": \"cm9x2render001\",\n    \"status\": \"ready\",\n    \"brand\": \"cm9x2brand0001\",\n    \"template\": \"quote-reel\",\n    \"ratio\": \"9x16\",\n    \"seconds\": 8,\n    \"cents\": 0,\n    \"url\": \"https:\u002F\u002F…\u002Fquote-reel.mp4\",\n    \"bytes\": 1482113,\n    \"error\": null,\n    \"createdAt\": \"2026-10-29T18:00:00.000Z\",\n    \"finishedAt\": \"2026-10-29T18:01:12.000Z\"\n  }\n}\n","json",[22,229,230,235,249,261,273,303,311,322,334,345,358,371,384,397,410,423,435,448,459,465],{"__ignoreMap":32},[36,231,232],{"class":38,"line":39},[36,233,234],{"class":63},"{\n",[36,236,237,240,243,246],{"class":38,"line":54},[36,238,239],{"class":50},"  \"id\"",[36,241,242],{"class":63},": ",[36,244,245],{"class":46},"\"cm9x2render001\"",[36,247,248],{"class":63},",\n",[36,250,251,254,256,259],{"class":38,"line":72},[36,252,253],{"class":50},"  \"type\"",[36,255,242],{"class":63},[36,257,258],{"class":46},"\"render.ready\"",[36,260,248],{"class":63},[36,262,263,266,268,271],{"class":38,"line":82},[36,264,265],{"class":50},"  \"created\"",[36,267,242],{"class":63},[36,269,270],{"class":46},"\"2026-10-29T18:01:12.000Z\"",[36,272,248],{"class":63},[36,274,275,278,281,284,286,289,292,295,297,300],{"class":38,"line":91},[36,276,277],{"class":50},"  \"business\"",[36,279,280],{"class":63},": { ",[36,282,283],{"class":50},"\"id\"",[36,285,242],{"class":63},[36,287,288],{"class":46},"\"cm9x2brand0001\"",[36,290,291],{"class":63},", ",[36,293,294],{"class":50},"\"name\"",[36,296,242],{"class":63},[36,298,299],{"class":46},"\"Main Street Bakery\"",[36,301,302],{"class":63}," },\n",[36,304,305,308],{"class":38,"line":97},[36,306,307],{"class":50},"  \"data\"",[36,309,310],{"class":63},": {\n",[36,312,313,316,318,320],{"class":38,"line":103},[36,314,315],{"class":50},"    \"id\"",[36,317,242],{"class":63},[36,319,245],{"class":46},[36,321,248],{"class":63},[36,323,324,327,329,332],{"class":38,"line":109},[36,325,326],{"class":50},"    \"status\"",[36,328,242],{"class":63},[36,330,331],{"class":46},"\"ready\"",[36,333,248],{"class":63},[36,335,336,339,341,343],{"class":38,"line":115},[36,337,338],{"class":50},"    \"brand\"",[36,340,242],{"class":63},[36,342,288],{"class":46},[36,344,248],{"class":63},[36,346,348,351,353,356],{"class":38,"line":347},10,[36,349,350],{"class":50},"    \"template\"",[36,352,242],{"class":63},[36,354,355],{"class":46},"\"quote-reel\"",[36,357,248],{"class":63},[36,359,361,364,366,369],{"class":38,"line":360},11,[36,362,363],{"class":50},"    \"ratio\"",[36,365,242],{"class":63},[36,367,368],{"class":46},"\"9x16\"",[36,370,248],{"class":63},[36,372,374,377,379,382],{"class":38,"line":373},12,[36,375,376],{"class":50},"    \"seconds\"",[36,378,242],{"class":63},[36,380,381],{"class":50},"8",[36,383,248],{"class":63},[36,385,387,390,392,395],{"class":38,"line":386},13,[36,388,389],{"class":50},"    \"cents\"",[36,391,242],{"class":63},[36,393,394],{"class":50},"0",[36,396,248],{"class":63},[36,398,400,403,405,408],{"class":38,"line":399},14,[36,401,402],{"class":50},"    \"url\"",[36,404,242],{"class":63},[36,406,407],{"class":46},"\"https:\u002F\u002F…\u002Fquote-reel.mp4\"",[36,409,248],{"class":63},[36,411,413,416,418,421],{"class":38,"line":412},15,[36,414,415],{"class":50},"    \"bytes\"",[36,417,242],{"class":63},[36,419,420],{"class":50},"1482113",[36,422,248],{"class":63},[36,424,426,429,431,433],{"class":38,"line":425},16,[36,427,428],{"class":50},"    \"error\"",[36,430,242],{"class":63},[36,432,221],{"class":50},[36,434,248],{"class":63},[36,436,438,441,443,446],{"class":38,"line":437},17,[36,439,440],{"class":50},"    \"createdAt\"",[36,442,242],{"class":63},[36,444,445],{"class":46},"\"2026-10-29T18:00:00.000Z\"",[36,447,248],{"class":63},[36,449,451,454,456],{"class":38,"line":450},18,[36,452,453],{"class":50},"    \"finishedAt\"",[36,455,242],{"class":63},[36,457,458],{"class":46},"\"2026-10-29T18:01:12.000Z\"\n",[36,460,462],{"class":38,"line":461},19,[36,463,464],{"class":63},"  }\n",[36,466,468],{"class":38,"line":467},20,[36,469,470],{"class":63},"}\n",[10,472,473,476,477,479],{},[22,474,475],{},"data"," is the same render ",[22,478,157],{}," gives you, so code that reads one reads the other. We add fields over time and never rename or remove one.",[10,481,482],{},"The request also carries these headers:",[171,484,485,495],{},[174,486,487],{},[177,488,489,492],{},[180,490,491],{},"Header",[180,493,494],{},"What it holds",[189,496,497,511,526],{},[177,498,499,504],{},[194,500,501],{},[22,502,503],{},"Webhook-Id",[194,505,506,507,510],{},"The render's ",[22,508,509],{},"id",". The same on every try.",[177,512,513,518],{},[194,514,515],{},[22,516,517],{},"Webhook-Event",[194,519,520,522,523,525],{},[22,521,198],{}," or ",[22,524,212],{},".",[177,527,528,533],{},[194,529,530],{},[22,531,532],{},"Webhook-Signature",[194,534,535,536,525],{},"Proof it came from us. See ",[537,538,540],"a",{"href":539},"#check-the-signature","Check the signature",[14,542,544],{"id":543},"answer-with-a-2xx","Answer with a 2xx",[10,546,547,548,551],{},"Answer within 5 seconds with any ",[22,549,550],{},"2xx"," status, and we're done. Anything else is a failure, a redirect included, and we try again after 1 minute, 5 minutes, 30 minutes, 2 hours and 6 hours, six tries in all. After that we stop.",[10,553,554,555,558,559,561],{},"We deliver ",[137,556,557],{},"at least once",". If your address answers late, you may get the same event twice, with the same ",[22,560,509],{},". Keep the ids you've handled and ignore a repeat.",[14,563,540],{"id":564},"check-the-signature",[10,566,567],{},"Anyone who learns your address could send to it. If it posts or charges anything, check that a request is ours first. Every request is signed with your account's secret, which you can ask for:",[27,569,571],{"className":29,"code":570,"language":31,"meta":32,"style":32},"curl {{base}}\u002Fwebhook-secret \\\n  -H \"Authorization: Bearer $API_KEY\"\n",[22,572,573,582],{"__ignoreMap":32},[36,574,575,577,580],{"class":38,"line":39},[36,576,43],{"class":42},[36,578,579],{"class":46}," {{base}}\u002Fwebhook-secret",[36,581,51],{"class":50},[36,583,584,586,588,590],{"class":38,"line":54},[36,585,57],{"class":50},[36,587,60],{"class":46},[36,589,64],{"class":63},[36,591,592],{"class":46},"\"\n",[27,594,596],{"className":225,"code":595,"language":227,"meta":32,"style":32},"{ \"secret\": \"whsec_…\" }\n",[22,597,598],{"__ignoreMap":32},[36,599,600,603,606,608,611],{"class":38,"line":39},[36,601,602],{"class":63},"{ ",[36,604,605],{"class":50},"\"secret\"",[36,607,242],{"class":63},[36,609,610],{"class":46},"\"whsec_…\"",[36,612,613],{"class":63}," }\n",[10,615,616],{},"It's the same for every key on your account, and asking again gives the same one. Keep it as private as a key, and keep it on your server.",[10,618,619,620,623],{},"The signature is made exactly as it is for the dashboard's webhooks, so the code on ",[537,621,540],{"href":622},"\u002Fdocs\u002Fwebhooks\u002Fsignatures"," works as it is: use the secret from above, and the raw body of the request.",[14,625,627],{"id":626},"zapier-make-and-n8n","Zapier, Make and n8n",[10,629,630,631,634,635,638],{},"These tools can't check signatures, and don't need to: the address they give you is the secret, so treat it like a password. You'll make two small automations, one that ",[137,632,633],{},"starts"," the render and one that ",[137,636,637],{},"hears"," the result.",[10,640,641,644],{},[137,642,643],{},"1. Make the receiver first",", so you have an address to give.",[171,646,647,660],{},[174,648,649],{},[177,650,651,654,657],{},[180,652,653],{},"Tool",[180,655,656],{},"Receiver",[180,658,659],{},"The address you copy",[189,661,662,684,700],{},[177,663,664,667,677],{},[194,665,666],{},"Zapier",[194,668,669,670,673,674],{},"A Zap that starts with ",[137,671,672],{},"Webhooks by Zapier"," › ",[137,675,676],{},"Catch Hook",[194,678,679,680],{},"The ",[681,682,683],"em",{},"custom webhook URL",[177,685,686,689,697],{},[194,687,688],{},"Make",[194,690,691,692,673,694],{},"A scenario that starts with ",[137,693,5],{},[137,695,696],{},"Custom webhook",[194,698,699],{},"The address Make shows when you add the webhook",[177,701,702,705,714],{},[194,703,704],{},"n8n",[194,706,707,708,711,712],{},"A workflow that starts with a ",[137,709,710],{},"Webhook"," node, method ",[22,713,168],{},[194,715,679,716,719],{},[137,717,718],{},"Production URL",", not the Test URL",[10,721,722,723,725],{},"Add your own steps after it: post ",[22,724,204],{}," to Instagram, send it by email, save it to Drive.",[10,727,728,731],{},[137,729,730],{},"2. Start the render"," from anything: a new spreadsheet row, a form, a schedule. Add a step that sends an HTTP request:",[171,733,734,743],{},[174,735,736],{},[177,737,738,740],{},[180,739,653],{},[180,741,742],{},"Step",[189,744,745,756,768],{},[177,746,747,749],{},[194,748,666],{},[194,750,751,673,753],{},[137,752,672],{},[137,754,755],{},"Custom Request",[177,757,758,760],{},[194,759,688],{},[194,761,762,673,765],{},[137,763,764],{},"HTTP",[137,766,767],{},"Make a request",[177,769,770,772],{},[194,771,704],{},[194,773,774,777],{},[137,775,776],{},"HTTP Request"," node",[10,779,780],{},"Set it up the same way in each:",[120,782,783,795,808],{},[123,784,785,788,789,791,792],{},[137,786,787],{},"Method and address:"," ",[22,790,168],{}," to ",[22,793,794],{},"{{base}}\u002Frenders",[123,796,797,788,800,803,804,807],{},[137,798,799],{},"Header:",[22,801,802],{},"Authorization"," with the value ",[22,805,806],{},"Bearer "," and your key",[123,809,810,813,814,816],{},[137,811,812],{},"Body:"," JSON, as in the example above, with ",[22,815,24],{}," set to the address you copied",[10,818,819,822,823,291,825,828],{},[137,820,821],{},"3. Teach the receiver what to expect."," The first time, run step 2 once and let the receiver catch a real request. Zapier, Make and n8n each use it to list ",[22,824,204],{},[22,826,827],{},"data.status"," and the rest as fields for the steps after it.",[10,830,831],{},"A few things that catch people out:",[120,833,834,848,851,857],{},[123,835,836,837,840,841,844,845,847],{},"n8n's ",[137,838,839],{},"Test URL"," only works while you're pressing ",[681,842,843],{},"Listen for test event",". Use the ",[137,846,718],{}," and turn the workflow on.",[123,849,850],{},"Zapier's Catch Hook address only works once the Zap is on.",[123,852,853,854,525],{},"If the receiver is off when a video finishes, we retry for about nine hours before we stop. See ",[537,855,544],{"href":856},"#answer-with-a-2xx",[123,858,859],{},"Send the key from a step in your own account only. Never share a workflow that holds it.",[861,862,863],"style",{},"html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":32,"searchDepth":54,"depth":54,"links":865},[866,867,868,869,870,871],{"id":16,"depth":54,"text":17},{"id":147,"depth":54,"text":148},{"id":161,"depth":54,"text":162},{"id":543,"depth":54,"text":544},{"id":564,"depth":54,"text":540},{"id":626,"depth":54,"text":627},"Be told when a render is ready or has failed, so there's nothing to poll. Works with Zapier, Make and n8n.","md",{},true,"\u002Fdocs\u002Fapi\u002Frender-webhooks","API",{"title":5,"description":872},"docs\u002Fapi\u002Frender-webhooks","4cchyryqY3GkBehIwjMXWPTCsdDhiPfcJJioaWD09IQ",[882,885,888,891,894,897,898,901],{"path":883,"title":884},"\u002Fdocs\u002Fapi","Video API",{"path":886,"title":887},"\u002Fdocs\u002Fapi\u002Fauthentication","Authentication",{"path":889,"title":890},"\u002Fdocs\u002Fapi\u002Ftemplates","Templates",{"path":892,"title":893},"\u002Fdocs\u002Fapi\u002Fbrands-and-photos","Brands and photos",{"path":895,"title":896},"\u002Fdocs\u002Fapi\u002Frenders","Renders",{"path":876,"title":5},{"path":899,"title":900},"\u002Fdocs\u002Fapi\u002Fusage","Usage",{"path":902,"title":903},"\u002Fdocs\u002Fapi\u002Ferrors-and-limits","Errors and limits",1795094521351]