1"use strict";(self.webpackChunkdwa_node_documentation=self.webpackChunkdwa_node_documentation||[]).push([[2637],{597:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>l,contentTitle:()=>s,default:()=>c,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var n=t(4848),i=t(8453);const r={title:"Webhook Dashboard",sidebar_position:1},s=void 0,a={id:"webhook-dashboard/webhook-dashboard",title:"Webhook Dashboard",description:"It is advised that you watch these videos on Webhooks and API calls first before proceeding.",source:"@site/docs/6-webhook-dashboard/webhook-dashboard.md",sourceDirName:"6-webhook-dashboard",slug:"/webhook-dashboard/webhook-dashboard",permalink:"/webhook-dashboard/webhook-dashboard",draft:!1,unlisted:!1,tags:[],version:"current",sidebarPosition:1,frontMatter:{title:"Webhook Dashboard",sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Scheduler",permalink:"/scheduler/scheduler"},next:{title:"Users",permalink:"/user-management/users"}},l={},d=[{value:"Secret Key",id:"secret-key",level:2},{value:"Create Webhook",id:"create-webhook",level:2},{value:"Edit Webhook",id:"edit-webhook",level:2},{value:"Delete Webhook",id:"delete-webhook",level:2}];function h(e){const o={admonition:"admonition",em:"em",h2:"h2",li:"li",ol:"ol",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.p,{children:(0,n.jsx)(o.strong,{children:"It is advised that you watch these videos on Webhooks and API calls first before proceeding."})}),"\n",(0,n.jsx)(o.p,{children:"This module is to allow triggering Drifts using Webhook API calls from applications or software outside of DWA. It uses Event Drifts that can be found in Default Applications, hence you would need to create an Event Drift first, before creating a Webhook."}),"\n",(0,n.jsx)(o.admonition,{type:"warning",children:(0,n.jsx)(o.p,{children:"Only one Event Drift can be tied to one CRON or Webhook."})}),"\n",(0,n.jsx)(o.h2,{id:"secret-key",children:"Secret Key"}),"\n",(0,n.jsx)(o.p,{children:"Secret key is a form of authorization that is generated to prevent other people from using the Webhooks you have created. This secret key should only be used by you and no one else. Only one key can exist at a given time and will be used across all your created Webhooks."}),"\n",(0,n.jsxs)(o.ol,{children:["\n",(0,n.jsx)(o.li,{children:'Click on the Gear Icon below the blue "Add New Webhook" button.'}),"\n",(0,n.jsx)(o.li,{children:"You can then copy the Secret Key by pressing the copy button."}),"\n",(0,n.jsx)(o.li,{children:"Regenerate Key allows you to change your Secret Key into a new one."}),"\n",(0,n.jsx)(o.li,{children:"Disable Key allows you to disable your Secret Key if you would like to disable all your Webhooks momentarily."}),"\n",(0,n.jsxs)(o.li,{children:['Your Secret Key is used in the Header section of your external application/software\'s Webhook terminal. The Key section will be "Authorization", and the Value section will be "apikey ',(0,n.jsx)(o.strong,{children:(0,n.jsx)(o.em,{children:"yourSecretKey"})}),'". (replace ',(0,n.jsx)(o.strong,{children:(0,n.jsx)(o.em,{children:"yourSecretKey"})})," with your own generated secret key)"]}),"\n"]}),"\n",(0,n.jsx)(o.h2,{id:"create-webhook",children:"Create Webhook"}),"\n",(0,n.jsxs)(o.ol,{children:["\n",(0,n.jsx)(o.li,{children:'Click on the blue "Add New Webhook" button on the top right-hand corner of the Dashboard.'}),"\n",(0,n.jsx)(o.li,{children:"You will be prompted to name the Webhook and select the Event Drift you wish to use."}),"\n",(0,n.jsx)(o.li,{children:"The current methods available now are just POST. You can then add any Parameters in the Query Params, Authentication methods in Headers, as well as any Request Body in JSON format."}),"\n",(0,n.jsx)(o.li,{children:"Click on Save and congratulations on your very first Webhook creation"}),"\n",(0,n.jsx)(o.li,{children:"You can then copy the custom Webhook URL provided and use it in other applications/software's webhook calls."}),"\n"]}),"\n",(0,n.jsx)(o.h2,{id:"edit-webhook",children:"Edit Webhook"}),"\n",(0,n.jsxs)(o.ol,{children:["\n",(0,n.jsx)(o.li,{children:"Click on the 3 dots next to the Webhook you wish to edit and click Edit."}),"\n",(0,n.jsx)(o.li,{children:"The interface to edit your Webhook is the same as how you would first create a Webhook."}),"\n",(0,n.jsx)(o.li,{children:"Click Save at the bottom right and you have completed editing your Webhook."}),"\n"]}),"\n",(0,n.jsx)(o.h2,{id:"delete-webhook",children:"Delete Webhook"}),"\n",(0,n.jsxs)(o.admonition,{type:"danger",children:[(0,n.jsx)(o.p,{children:"This will delete your Webhook, and you won't be able to retrieve it."}),(0,n.jsx)(o.admonition,{type:"note",children:(0,n.jsx)(o.p,{children:"This will not delete the Event Drift, instead it will make your Event Drift available to be selected in Webhook creation again."})})]}),"\n",(0,n.jsxs)(o.ol,{children:["\n",(0,n.jsx)(o.li,{children:"Click on the 3 dots next to the Webhook you wish to delete."}
1),"\n",(0,n.jsx)(o.li,{children:"Click on Delete and your Webhook will be deleted."}),"\n"]})]})}function c(e={}){const{wrapper:o}={...(0,i.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},8453:(e,o,t)=>{t.d(o,{R:()=>s,x:()=>a});var n=t(6540);const i={},r=n.createContext(i);function s(e){const o=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function a(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),n.createElement(r.Provider,{value:o},e.children)}}}]);
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.