1"use strict";(self.webpackChunkdocusaurus=self.webpackChunkdocusaurus||[]).push([[539],{28453:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>a});var o=t(96540);const s={},i=o.createContext(s);function r(e){const n=o.useContext(i);return o.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),o.createElement(i.Provider,{value:n},e.children)}},42536:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var o=t(74848),s=t(28453);const i={id:"hooks",title:"Web Hooks",sidebar_label:"\u2693 Web Hooks"},r=void 0,a={id:"server/account/hooks",title:"Web Hooks",description:"Programmatic listening to video status change events",source:"@site/docs/server/account/hooks.md",sourceDirName:"server/account",slug:"/server/account/hooks",permalink:"/docs/server/account/hooks",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{id:"hooks",title:"Web Hooks",sidebar_label:"\u2693 Web Hooks"},sidebar:"server",previous:{title:"\u270d Rename Videos",permalink:"/docs/server/videomanagement/renaming"},next:{title:"\ud83d\udcbe Bandwidth Consumption",permalink:"/docs/server/account/video-usage"}},c={},l=[{value:"Programmatic listening to video status change events",id:"programmatic-listening-to-video-status-change-events",level:3},{value:"<strong>Sample CURL statements</strong>",id:"sample-curl-statements",level:3}];function d(e){const n={a:"a",code:"code",em:"em",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"programmatic-listening-to-video-status-change-events",children:"Programmatic listening to video status change events"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.em,{children:"Date: 2018-09-30"})}),"\n",(0,o.jsx)(n.p,{children:"Three actions are supported using web hooks:"}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsx)(n.li,{children:"List all hooks"}),"\n",(0,o.jsx)(n.li,{children:"Create new hook"}),"\n",(0,o.jsx)(n.li,{children:"Delete a hook"}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.a,{href:"/docs/server/authorization",children:"Read on authorization"})," for more details on the authorization header in the above request"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Supported events: ",(0,o.jsx)(n.code,{children:"video:ready"})," and ",(0,o.jsx)(n.code,{children:"video:readyall"})]}),"\n",(0,o.jsxs)(n.li,{children:["Supported types: ",(0,o.jsx)(n.code,{children:"http"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Webhook HTTP request information:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Method: POST"}),"\n",(0,o.jsx)(n.li,{children:"Content-type: application/json"}),"\n",(0,o.jsx)(n.li,{children:"Sample body:"}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"{\n hookId: '5d56a5234f99xxxxxxxxxxxxxxxxxxxx',\n event: 'video:ready',\n time: 1538330269833,\n payload: {\n id: '8cf4129200a4xxxxxxxxxxxxxxxxxxxx',\n title: 'The Daily Dweebs.mp4',\n upload_time: 1538329973,\n tags: null,\n length: 60,\n status: 'ready'\n }\n}\n"})}),"\n",(0,o.jsx)(n.h3,{id:"sample-curl-statements",children:(0,o.jsx)(n.strong,{children:"Sample CURL statements"})}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsx)(n.li,{children:"List all hooks"}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"curl -i https://dev.vdocipher.com/api/hooks/ -H 'authorization: Apisecret __________' -H 'content-type: application/json'\n"})}),"\n",(0,o.jsxs)(n.ol,{start:"2",children:["\n",(0,o.jsx)(n.li,{children:"Create new hook"}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'curl -i -X POST https://dev.vdocipher.com/api/hooks/ -H \'authorization: Apisecret __________\' -H \'content-type: application/json\' -d \'{"type": "http", "value": "http://example.com/path/","event": "video:ready", "status": 1}\'\n'})}),"\n",(0,o.jsxs)(n.ol,{start:"3",children:["\n",(0,o.jsx)(n.li,{children:"Delete a hook"}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"curl -i -X DELETE https://dev.vdocipher.com/api/hooks/ -H 'authorization: Apisecret __________' -H 'content-type: application/json' -d '{\"uuid\": \"_______\"}'\n"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.