71888b4d.e25d5ee5.js

(window.webpackJsonp=window.webpackJsonp||[]).push([[58],{133:function(e,t,n){"use strict";n.r(t),n.d(t,"frontMatter",(function(){return i})),n.d(t,"metadata",(function(){return s})),n.d(t,"rightToc",(function(){return c})),n.d(t,"default",(function(){return l}));var a=n(3),o=n(7),r=(n(0),n(192)),i={id:"how-to-create-webhook-for-cicd",title:"How to create Webhook for CI/CD"},s={unversionedId:"how-tos/how-to-create-webhook-for-cicd",id:"how-tos/how-to-create-webhook-for-cicd",isDocsHomePage:!1,title:"How to create Webhook for CI/CD",description:"Description",source:"@site/docs\\how-tos\\how-to-create-webhook-for-cicd.md",slug:"/how-tos/how-to-create-webhook-for-cicd",permalink:"/docs/how-tos/how-to-create-webhook-for-cicd",version:"current",sidebar:"docs",previous:{title:"How to Deploy Test Cases",permalink:"/docs/how-tos/how-to-deploy-test-cases"},next:{title:"How to generate Execution report",permalink:"/docs/how-tos/how-to-generate-execution-report"}},c=[{value:"Description",id:"description",children:[{value:"What is Webhook in the context of CI/CD?",id:"what-is-webhook-in-the-context-of-cicd",children:[]},{value:"What is the necessity of Webhook in the context of CI/CD?",id:"what-is-the-necessity-of-webhook-in-the-context-of-cicd",children:[]}]},{value:"Steps",id:"steps",children:[]}],b={rightToc:c};function l(e){var t=e.components,i=Object(o.a)(e,["components"]);return Object(r.b)("wrapper",Object(a.a)({},b,i,{components:t,mdxType:"MDXLayout"}),Object(r.b)("h2",{id:"description"},"Description"),Object(r.b)("h3",{id:"what-is-webhook-in-the-context-of-cicd"},"What is Webhook in the context of CI/CD?"),Object(r.b)("p",null,"In the context of ",Object(r.b)("strong",{parentName:"p"},"CI/CD (Continuous Integration/Continuous Delivery)"),", a ",Object(r.b)("strong",{parentName:"p"},"Webhook")," is a mechanism that allows different systems or services to communicate and trigger actions based on events or updates.  "),Object(r.b)("p",null,"Specifically, a ",Object(r.b)("strong",{parentName:"p"},"Webhook")," is a user-defined HTTP callback or endpoint that receives notifications or data payloads from a remote server when a particular event occurs. These events can vary depending on the ",Object(r.b)("strong",{parentName:"p"},"CI/CD")," platform or tool being used but typically include actions such as code commits, pull requests, builds, test results or deployment completions.  "),Object(r.b)("p",null,"When a ",Object(r.b)("strong",{parentName:"p"},"Webhook")," is set up, the ",Object(r.b)("strong",{parentName:"p"},"CI/CD")," platform will send an HTTP POST request to the specified URL whenever the associated event occurs. The payload of the request usually contains relevant information about the event, such as the commit details, branch information, or build status.  "),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Webhooks")," are commonly used in ",Object(r.b)("strong",{parentName:"p"},"CI/CD")," workflows to automate processes and enable integrations with other tools and services. For example, when a code commit occurs in a version control system (e.g. Git), a ",Object(r.b)("strong",{parentName:"p"},"Webhook")," can be configured to trigger an automatic build and deployment processes in a ",Object(r.b)("strong",{parentName:"p"},"CI/CD")," tool (e.g. ",Object(r.b)("strong",{parentName:"p"},"Jenkins"),", ",Object(r.b)("strong",{parentName:"p"},"Travis CI"),", or ",Object(r.b)("strong",{parentName:"p"},"Gitlab CI/CD"),"). This helps steamline the development and release pipeline by automatically initiating subsequent stages based on specific events.  "),Object(r.b)("p",null,"By leveraging webhooks, ",Object(r.b)("strong",{parentName:"p"},"CI/CD")," pipelines can be designed to respond to changes in real-time, ensuring rapid feedback, faster deployments, and increased overall efficiency.  "),Object(r.b)("h3",{id:"what-is-the-necessity-of-webhook-in-the-context-of-cicd"},"What is the necessity of Webhook in the context of CI/CD?"),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Webhooks")," are essential in ",Object(r.b)("strong",{parentName:"p"},"CI/CD")," workflows for real-time notifications, automation, integration, collaboration, and establishing a continuous feedback loop. They enable immediate notifications, automate actions based on events, integrate various tools and services, foster collaboration among teams, and facilitate a continuous flow of information and feedback."),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Webhook")," enhance the efficiency and reliability of ",Object(r.b)("strong",{parentName:"p"},"CI/CD")," pipelines, leading to faster and streamlined software development and delivery."),Object(r.b)("h2",{id:"steps"},"Steps"),Object(r.b)("ol",null,Object(r.b)("li",{parentName:"ol"},"From the ",Object(r.b)("strong",{parentName:"li"},"Menu bar"),", go to the ",Object(r.b)("strong",{parentName:"li"},"Testing")," then ",Object(r.b)("strong",{parentName:"li"},"Run/CI Presets")," option.")),Object(r.b)("p",null,Object(r.b)("img",{src:n(459).default})),Object(r.b)("ol",{start:2},Object(r.b)("li",{parentName:"ol"},Object(r.b)("p",{parentName:"li"},"Go to the ",Object(r.b)("strong",{parentName:"p"},"Preset")," page."),Object(r.b)("blockquote",{parentName:"li"},Object(r.b)("p",{parentName:"blockquote"},"A ",Object(r.b)("em",{parentName:"p"},"Preset")," page refers to a preconfigured or predefined test page that serves as a starting point for conducting specific tests or simulations.  ")),Object(r.b)("blockquote",{parentName:"li"},Object(r.b)("p",{parentName:"blockquote"},"The ",Object(r.b)("em",{parentName:"p"},"Preset")," page has a table named ",Object(r.b)("em",{parentName:"p"},"View/Edit Preset")," which contain the following informations like:"),Object(r.b)("ul",{parentName:"blockquote"},Object(r.b)("li",{parentName:"ul"},Object(r.b)("strong",{parentName:"li"},"Preset Name")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("strong",{parentName:"li"},"Created By")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("strong",{parentName:"li"},"Modified By")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("strong",{parentName:"li"},"Created On")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("strong",{parentName:"li"},"Modified On")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("strong",{parentName:"li"},"Webhook ID")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("strong",{parentName:"li"},"Webhook URL")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("strong",{parentName:"li"},"Curl Command")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("strong",{parentName:"li"},"Delete"),".")))),Object(r.b)("li",{parentName:"ol"},Object(r.b)("p",{parentName:"li"},"Click on the ",Object(r.b)("strong",{parentName:"p"},"Create New Preset +")," button."),Object(r.b)("blockquote",{parentName:"li"},Object(r.b)("p",{parentName:"blockquote"},Object(r.b)("em",{parentName:"p"},"Create New Preset")," button allow users to generate a new preconfigured template or settings for conducting tests or simulations with specific parameters.")))),Object(r.b)("p",null,Object(r.b)("img",{src:n(460).default})),Object(r.b)("ol",{start:4},Object(r.b)("li",{parentName:"ol"},"Go to the ",Object(r.b)("strong",{parentName:"li"},"Deploy Presets")," page.",Object(r.b)("blockquote",{parentName:"li"},Object(r.b)("p",{parentName:"blockquote"},"The function of ",Object(r.b)("em",{parentName:"p"},"Deploy Presets")," page is to manage and apply preconfigured settings or configurations to relevant test scenarios for streamlined and standerdized testing processes."))),Object(r.b)("li",{parentName:"ol"},"Enter the ",Object(r.b)("strong",{parentName:"li"},"Preset Name"),".",Object(r.b)("blockquote",{parentName:"li"},Object(r.b)("p",{parentName:"blockquote"},"Entering the ",Object(r.b)("em",{parentName:"p"},"Preset Name")," is necessary for easy identification and categorization of preconfigured settings, ensuring clarity and organization in managing various test scenarios.")))),Object(r.b)("p",null,Object(r.b)("img",{src:n(461).default})),Object(r.b)("ol",{start:6},Object(r.b)("li",{parentName:"ol"},"Click to ",Object(r.b)("strong",{parentName:"li"},"Search Set")," of the ",Object(r.b)("strong",{parentName:"li"},"Preset Deployment")," tab."),Object(r.b)("li",{parentName:"ol"},"Click on the ",Object(r.b)("strong",{parentName:"li"},"Search")," button.",Object(r.b)("blockquote",{parentName:"li"},Object(r.b)("p",{parentName:"blockquote"},"In the ",Object(r.b)("em",{parentName:"p"},"Preset Deployment")," tab, the ",Object(r.b)("em",{parentName:"p"},"Search Set")," allows users to filter and display specific preconfigured settings, making it easier to locate and apply the desired presets to relevant test scenarios.")))),Object(r.b)("p",null,Object(r.b)("img",{src:n(462).default})),Object(r.b)("ol",{start:8},Object(r.b)("li",{parentName:"ol"},"Fill up the ",Object(r.b)("strong",{parentName:"li"},"Information")," of the ",Object(r.b)("strong",{parentName:"li"},"Preset Deployment")," tab like:")),Object(r.b)("ul",null,Object(r.b)("li",{parentName:"ul"},"Assigned testers, "),Object(r.b)("li",{parentName:"ul"},"Send report to, "),Object(r.b)("li",{parentName:"ul"},"Milestone, "),Object(r.b)("li",{parentName:"ul"},"Run Objective, "),Object(r.b)("li",{parentName:"ul"},"Version "),Object(r.b)("li",{parentName:"ul"},"Platform (Browser, Mobile).")),Object(r.b)("p",null,Object(r.b)("img",{src:n(463).default})),Object(r.b)("ol",{start:9},Object(r.b)("li",{parentName:"ol"},Object(r.b)("p",{parentName:"li"},"Multiple of ",Object(r.b)("strong",{parentName:"p"},"Assigned testers")," and ",Object(r.b)("strong",{parentName:"p"},"Send report to")," can be selected.")),Object(r.b)("li",{parentName:"ol"},Object(r.b)("p",{parentName:"li"},"To remove any ",Object(r.b)("strong",{parentName:"p"},"Assigned testers")," or ",Object(r.b)("strong",{parentName:"p"},"Send report to"),", click on the ",Object(r.b)("strong",{parentName:"p"},"Cross sign (X)")," button."),Object(r.b)("blockquote",{parentName:"li"},Object(r.b)("p",{parentName:"blockquote"},Object(r.b)("em",{parentName:"p"},"Assigned Testers")," refers to the individuals or team members who are granted access to and can utilize specific preconfigured settings for executing tests or simulations.")),Object(r.b)("blockquote",{parentName:"li"},Object(r.b)("p",{parentName:"blockquote"},Object(r.b)("em",{parentName:"p"},"Send report to")," indicates the designated recipents or stakeholders who will receive the test results and findings generated using the preconfigured settings after testing is completed.")),Object(r.b)("blockquote",{parentName:"li"},Object(r.b)("p",{parentName:"blockquote"},"Selecting multiple of ",Object(r.b)("em",{parentName:"p"},"Assigned testers")," and ",Object(r.b)("em",{parentName:"p"},"Send report to")," in terms of presets allows for efficient distribution of testing responsibilities and comprehensive communication of test results to various team members and stakeholders, ensuring a coordinated and thorough testing process.")),Object(r.b)("blockquote",{parentName:"li"},Object(r.b)("p",{parentName:"blockquote"},"Removing any ",Object(r.b)("em",{parentName:"p"},"Assigned testers")," and ",Object(r.b)("em",{parentName:"p"},"Send report to")," may be necessary to update or reassign testing responsibilities and recipents, ensuring the most relevant and up-to-date individuals receive the test tasks and results.")))),Object(r.b)("p",null,Object(r.b)("img",{src:n(464).default})),Object(r.b)("ol",{start:11},Object(r.b)("li",{parentName:"ol"},"Click on the ",Object(r.b)("strong",{parentName:"li"},"Save")," button.")),Object(r.b)("p",null,Object(r.b)("img",{src:n(465).default})))}l.isMDXComponent=!0},192:function(e,t,n){"use strict";n.d(t,"a",(function(){return p})),n.d(t,"b",(function(){return d}));var a=n(0),o=n.n(a);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function c(e,t){if(null==e)return{};var n,a,o=function(e,t){if(null==e)return{};var n,a,o={},r=Object.keys(e);for(a=0;a<r.length;a++)n=r[a],t.indexOf(n)>=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a<r.length;a++)n=r[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var b=o.a.createContext({}),l=function(e){var t=o.a.useContext(b),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=l(e.components);return o.a.createElement(b.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return o.a.createElement(o.a.Fragment,{},t)}},u=o.a.forwardRef((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,i=e.parentName,b=c(e,["components","mdxType","originalType","parentName"]),p=l(n),u=a,d=p["".concat(i,".").concat(u)]||p[u]||m[u]||r;return n?o.a.createElement(d,s(s({ref:t},b),{},{components:n})):o.a.createElement(d,s({ref:t},b))}));function d(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,i=new Array(r);i[0]=u;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s.mdxType="string"==typeof e?e:a,i[1]=s;for(var b=2;b<r;b++)i[b]=n[b];return o.a.createElement.apply(null,i)}return o.a.createElement.apply(null,n)}u.displayName="MDXCreateElement"},459:function(e,t,n){"use strict";n.r(t),t.default=n.p+"assets/images/run-ci-c1bdd515b7abdb46fc15ee372422eaca.png"},460:function(e,t,n){"use strict";n.r(t),t.default=n.p+"assets/images/preset-pg-face4de6fb6c0f843000e2c46dc673b3.png"},461:function(e,t,n){"use strict";n.r(t),t.default=n.p+"assets/images/preset-name-df7fccca9e306d072b2d5e7bdb819e6b.png"},462:function(e,t,n){"use strict";n.r(t),t.default=n.p+"assets/images/search-set-d49211d11f22165b95584a45fd107acb.png"},463:function(e,t,n){"use strict";n.r(t),t.default=n.p+"assets/images/preset-information-5e92761cc623a361d7c284700fc205b5.png"},464:function(e,t,n){"use strict";n.r(t),t.default=n.p+"assets/images/remove-report-06458c5a7f450ba9cc19eafbfcad7930.png"},465:function(e,t,n){"use strict";n.r(t),t.default=n.p+"assets/images/save-preset-f7402f919fca9973a426c9b886c01ad9.png"}}]);