CINXE.COM

<!DOCTYPE html><html data-color-mode="auto" data-light-theme="light" data-dark-theme="dark" lang="en"><head><meta charSet="utf-8" data-next-head=""/><meta name="viewport" content="width=device-width, initial-scale=1" data-next-head=""/><link rel="icon" type="image/png" href="/assets/cb-345/images/site/favicon.png" data-next-head=""/><link href="/manifest.json" rel="manifest" data-next-head=""/><meta name="google-site-verification" content="c1kuD-K2HIVF635lypcsWPoD4kilo5-jA_wBFyT4uMY" data-next-head=""/><title data-next-head="">Webhook events and payloads - GitHub Docs</title><meta name="description" content="Learn about when each webhook event occurs and what the payload contains." data-next-head=""/><link rel="alternate" hrefLang="zh-Hans" href="https://docs.github.com/zh/webhooks/webhook-events-and-payloads" data-next-head=""/><link rel="alternate" hrefLang="es" href="https://docs.github.com/es/webhooks/webhook-events-and-payloads" data-next-head=""/><link rel="alternate" hrefLang="pt" href="https://docs.github.com/pt/webhooks/webhook-events-and-payloads" data-next-head=""/><link rel="alternate" hrefLang="ru" href="https://docs.github.com/ru/webhooks/webhook-events-and-payloads" data-next-head=""/><link rel="alternate" hrefLang="ja" href="https://docs.github.com/ja/webhooks/webhook-events-and-payloads" data-next-head=""/><link rel="alternate" hrefLang="fr" href="https://docs.github.com/fr/webhooks/webhook-events-and-payloads" data-next-head=""/><link rel="alternate" hrefLang="de" href="https://docs.github.com/de/webhooks/webhook-events-and-payloads" data-next-head=""/><link rel="alternate" hrefLang="ko" href="https://docs.github.com/ko/webhooks/webhook-events-and-payloads" data-next-head=""/><meta name="keywords" content="Webhooks" data-next-head=""/><meta name="path-language" content="en" data-next-head=""/><meta name="path-version" content="free-pro-team@latest" data-next-head=""/><meta name="path-product" content="webhooks" data-next-head=""/><meta name="path-article" content="webhooks/webhook-events-and-payloads" data-next-head=""/><meta name="page-document-type" content="article" data-next-head=""/><meta name="status" content="200" data-next-head=""/><meta property="og:site_name" content="GitHub Docs" data-next-head=""/><meta property="og:title" content="Webhook events and payloads - GitHub Docs" data-next-head=""/><meta property="og:type" content="article" data-next-head=""/><meta property="og:url" content="https://docs-internal.github.com/en/webhooks/webhook-events-and-payloads" data-next-head=""/><meta property="og:image" content="https://github.githubassets.com/images/modules/open_graph/github-logo.png" data-next-head=""/><link rel="preload" href="/_next/static/css/befc662d3a7d0204.css" as="style"/><link rel="stylesheet" href="/_next/static/css/befc662d3a7d0204.css" data-n-g=""/><link rel="preload" href="/_next/static/css/d4755f7f8f7154d4.css" as="style"/><link rel="stylesheet" href="/_next/static/css/d4755f7f8f7154d4.css" data-n-p=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills-42372ed130431b0a.js"></script><script src="/_next/static/chunks/webpack-116ebaba837cd987.js" defer=""></script><script src="/_next/static/chunks/framework-19baaf6675f9027b.js" defer=""></script><script src="/_next/static/chunks/main-a2c1e924d9046c3c.js" defer=""></script><script src="/_next/static/chunks/pages/_app-ed2149ad90aeada5.js" defer=""></script><script src="/_next/static/chunks/727f57db-4bd4b01815458cf5.js" defer=""></script><script src="/_next/static/chunks/4197-10db3e81f24542eb.js" defer=""></script><script src="/_next/static/chunks/2872-eaff82eddfa86435.js" defer=""></script><script src="/_next/static/chunks/5589-f1d11854d6f74584.js" defer=""></script><script src="/_next/static/chunks/3460-dd9d4ed72839fb08.js" defer=""></script><script src="/_next/static/chunks/7549-868ecaf8a29cbce0.js" defer=""></script><script src="/_next/static/chunks/pages/%5BversionId%5D/webhooks/webhook-events-and-payloads-2e3265fdc0d90259.js" defer=""></script><script src="/_next/static/7mRJ1xbGYF7vO0HMbUsiR/_buildManifest.js" defer=""></script><script src="/_next/static/7mRJ1xbGYF7vO0HMbUsiR/_ssgManifest.js" defer=""></script><style data-styled="" data-styled-version="5.3.5">.cEhRXB{-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;}/*!sc*/ .dmdEgz{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;pointer-events:none;}/*!sc*/ .hROlum{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;-webkit-box-flex:1;-webkit-flex-grow:1;-ms-flex-positive:1;flex-grow:1;min-width:0;}/*!sc*/ .bmseMA{-webkit-box-flex:1;-webkit-flex-grow:1;-ms-flex-positive:1;flex-grow:1;font-weight:400;word-break:break-word;}/*!sc*/ .ivpQTm{-webkit-box-flex:1;-webkit-flex-grow:1;-ms-flex-positive:1;flex-grow:1;font-weight:600;word-break:break-word;}/*!sc*/ .Ywlla{list-style:none;}/*!sc*/ .cUxMoC{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-flex:1;-webkit-flex-grow:1;-ms-flex-positive:1;flex-grow:1;}/*!sc*/ .lmYNOb{height:20px;-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;color:var(--fgColor-muted,var(--color-fg-muted,#656d76));margin-left:8px;font-weight:initial;}/*!sc*/ [data-variant="danger"]:hover .Box-sc-g0xbh4-0,[data-variant="danger"]:active .lmYNOb{color:var(--fgColor-default,var(--color-fg-default,#1F2328));}/*!sc*/ .gMkIpo{padding:0;margin:0;display:none;}/*!sc*/ .gMkIpo *{font-size:14px;}/*!sc*/ .eQiQea{grid-area:topper;}/*!sc*/ .ijSsTo{grid-area:intro;}/*!sc*/ .giVcWX{-webkit-align-self:flex-start;-ms-flex-item-align:start;align-self:flex-start;grid-area:sidebar;}/*!sc*/ .kohLxz{grid-area:content;}/*!sc*/ data-styled.g3[id="Box-sc-g0xbh4-0"]{content:"cEhRXB,dmdEgz,hROlum,bmseMA,ivpQTm,Ywlla,cUxMoC,lmYNOb,gMkIpo,eQiQea,ijSsTo,giVcWX,kohLxz,"}/*!sc*/ .hXCKEr{border-radius:6px;border:1px solid;border-color:transparent;font-family:inherit;font-weight:500;font-size:14px;cursor:pointer;-webkit-appearance:none;-moz-appearance:none;appearance:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-text-decoration:none;text-decoration:none;text-align:center;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;height:32px;padding:0 12px;gap:8px;min-width:-webkit-max-content;min-width:-moz-max-content;min-width:max-content;-webkit-transition:80ms cubic-bezier(0.65,0,0.35,1);transition:80ms cubic-bezier(0.65,0,0.35,1);-webkit-transition-property:color,fill,background-color,border-color;transition-property:color,fill,background-color,border-color;color:var(--button-default-fgColor-rest,var(--color-btn-text,#24292f));background-color:transparent;box-shadow:none;}/*!sc*/ .hXCKEr:focus:not(:disabled){box-shadow:none;outline:2px solid var(--fgColor-accent,var(--color-accent-fg,#0969da));outline-offset:-2px;}/*!sc*/ .hXCKEr:focus:not(:disabled):not(:focus-visible){outline:solid 1px transparent;}/*!sc*/ .hXCKEr:focus-visible:not(:disabled){box-shadow:none;outline:2px solid var(--fgColor-accent,var(--color-accent-fg,#0969da));outline-offset:-2px;}/*!sc*/ .hXCKEr[href]{display:-webkit-inline-box;display:-webkit-inline-flex;display:-ms-inline-flexbox;display:inline-flex;}/*!sc*/ .hXCKEr[href]:hover{-webkit-text-decoration:none;text-decoration:none;}/*!sc*/ .hXCKEr:hover{-webkit-transition-duration:80ms;transition-duration:80ms;}/*!sc*/ .hXCKEr:active{-webkit-transition:none;transition:none;}/*!sc*/ .hXCKEr[data-inactive]{cursor:auto;}/*!sc*/ .hXCKEr:disabled{cursor:not-allowed;box-shadow:none;color:var(--fgColor-disabled,var(--color-primer-fg-disabled,#8c959f));}/*!sc*/ .hXCKEr:disabled [data-component=ButtonCounter],.hXCKEr:disabled [data-component="leadingVisual"],.hXCKEr:disabled [data-component="trailingAction"]{color:inherit;}/*!sc*/ @media (forced-colors:active){.hXCKEr:focus{outline:solid 1px transparent;}}/*!sc*/ .hXCKEr [data-component=ButtonCounter]{font-size:12px;}/*!sc*/ .hXCKEr[data-component=IconButton]{display:inline-grid;padding:unset;place-content:center;width:32px;min-width:unset;}/*!sc*/ .hXCKEr[data-size="small"]{padding:0 8px;height:28px;gap:4px;font-size:12px;}/*!sc*/ .hXCKEr[data-size="small"] [data-component="text"]{line-height:calc(20 / 12);}/*!sc*/ .hXCKEr[data-size="small"] [data-component=ButtonCounter]{font-size:12px;}/*!sc*/ .hXCKEr[data-size="small"] [data-component="buttonContent"] > :not(:last-child){margin-right:4px;}/*!sc*/ .hXCKEr[data-size="small"][data-component=IconButton]{width:28px;padding:unset;}/*!sc*/ .hXCKEr[data-size="large"]{padding:0 16px;height:40px;gap:8px;}/*!sc*/ .hXCKEr[data-size="large"] [data-component="buttonContent"] > :not(:last-child){margin-right:8px;}/*!sc*/ .hXCKEr[data-size="large"][data-component=IconButton]{width:40px;padding:unset;}/*!sc*/ .hXCKEr[data-block="block"]{width:100%;}/*!sc*/ .hXCKEr[data-label-wrap="true"]{min-width:-webkit-fit-content;min-width:-moz-fit-content;min-width:fit-content;height:unset;min-height:var(--control-medium-size,2rem);}/*!sc*/ .hXCKEr[data-label-wrap="true"] [data-component="buttonContent"]{-webkit-flex:1 1 auto;-ms-flex:1 1 auto;flex:1 1 auto;-webkit-align-self:stretch;-ms-flex-item-align:stretch;align-self:stretch;padding-block:calc(var(--control-medium-paddingBlock,0.375rem) - 2px);}/*!sc*/ .hXCKEr[data-label-wrap="true"] [data-component="text"]{white-space:unset;word-break:break-word;}/*!sc*/ .hXCKEr[data-label-wrap="true"][data-size="small"]{height:unset;min-height:var(--control-small-size,1.75rem);}/*!sc*/ .hXCKEr[data-label-wrap="true"][data-size="small"] [data-component="buttonContent"]{padding-block:calc(var(--control-small-paddingBlock,0.25rem) - 2px);}/*!sc*/ .hXCKEr[data-label-wrap="true"][data-size="large"]{height:unset;min-height:var(--control-large-size,2.5rem);padding-inline:var(--control-large-paddingInline-spacious,1rem);}/*!sc*/ .hXCKEr[data-label-wrap="true"][data-size="large"] [data-component="buttonContent"]{padding-block:calc(var(--control-large-paddingBlock,0.625rem) - 2px);}/*!sc*/ .hXCKEr[data-inactive]:not([disabled]){background-color:var(--button-inactive-bgColor,var(--button-inactive-bgColor-rest,var(--color-btn-inactive-bg,#eaeef2)));border-color:var(--button-inactive-bgColor,var(--button-inactive-bgColor-rest,var(--color-btn-inactive-bg,#eaeef2)));color:var(--button-inactive-fgColor,var(--button-inactive-fgColor-rest,var(--color-btn-inactive-text,#57606a)));}/*!sc*/ .hXCKEr[data-inactive]:not([disabled]):focus-visible{box-shadow:none;}/*!sc*/ .hXCKEr [data-component="leadingVisual"]{grid-area:leadingVisual;color:var(--fgColor-muted,var(--color-fg-muted,#656d76));}/*!sc*/ .hXCKEr [data-component="text"]{grid-area:text;line-height:calc(20/14);white-space:nowrap;}/*!sc*/ .hXCKEr [data-component="trailingVisual"]{grid-area:trailingVisual;}/*!sc*/ .hXCKEr [data-component="trailingAction"]{margin-right:-4px;color:var(--fgColor-muted,var(--color-fg-muted,#656d76));}/*!sc*/ .hXCKEr [data-component="buttonContent"]{-webkit-flex:1 0 auto;-ms-flex:1 0 auto;flex:1 0 auto;display:grid;grid-template-areas:"leadingVisual text trailingVisual";grid-template-columns:min-content minmax(0,auto) min-content;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-align-content:center;-ms-flex-line-pack:center;align-content:center;}/*!sc*/ .hXCKEr [data-component="buttonContent"] > :not(:last-child){margin-right:8px;}/*!sc*/ .hXCKEr [data-component="loadingSpinner"]{grid-area:text;margin-right:0px !important;place-self:center;}/*!sc*/ .hXCKEr [data-component="loadingSpinner"] + [data-component="text"]{visibility:hidden;}/*!sc*/ .hXCKEr:hover:not([disabled]){background-color:var(--control-transparent-bgColor-hover,var(--color-action-list-item-default-hover-bg,rgba(208,215,222,0.32)));}/*!sc*/ .hXCKEr:active:not([disabled]){background-color:var(--control-transparent-bgColor-active,var(--color-action-list-item-default-active-bg,rgba(208,215,222,0.48)));}/*!sc*/ .hXCKEr[aria-expanded=true]{background-color:var(--control-transparent-bgColor-selected,var(--color-action-list-item-default-selected-bg,rgba(208,215,222,0.24)));}/*!sc*/ .hXCKEr[data-component="IconButton"][data-no-visuals]{color:var(--fgColor-muted,var(--color-fg-muted,#656d76));}/*!sc*/ .hXCKEr[data-no-visuals]{color:var(--fgColor-accent,var(--color-accent-fg,#0969da));}/*!sc*/ .hXCKEr:has([data-component="ButtonCounter"]){color:var(--button-default-fgColor-rest,var(--color-btn-text,#24292f));}/*!sc*/ .hXCKEr:disabled[data-no-visuals]{color:var(--fgColor-disabled,var(--color-primer-fg-disabled,#8c959f));}/*!sc*/ .hXCKEr:disabled[data-no-visuals] [data-component=ButtonCounter]{color:inherit;}/*!sc*/ .hXCKEr{height:auto;text-align:left;}/*!sc*/ .hXCKEr span:first-child{display:inline;}/*!sc*/ .jOdgLl{border-radius:6px;border:1px solid;border-color:var(--button-default-borderColor-rest,var(--button-default-borderColor-rest,var(--color-btn-border,rgba(31,35,40,0.15))));font-family:inherit;font-weight:500;font-size:14px;cursor:pointer;-webkit-appearance:none;-moz-appearance:none;appearance:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-text-decoration:none;text-decoration:none;text-align:center;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;height:32px;padding:0 12px;gap:8px;min-width:-webkit-max-content;min-width:-moz-max-content;min-width:max-content;-webkit-transition:80ms cubic-bezier(0.65,0,0.35,1);transition:80ms cubic-bezier(0.65,0,0.35,1);-webkit-transition-property:color,fill,background-color,border-color;transition-property:color,fill,background-color,border-color;color:var(--button-default-fgColor-rest,var(--color-btn-text,#24292f));background-color:var(--button-default-bgColor-rest,var(--color-btn-bg,#f6f8fa));box-shadow:var(--button-default-shadow-resting,var(--color-btn-shadow,0 1px 0 rgba(31,35,40,0.04))),var(--button-default-shadow-inset,var(--color-btn-inset-shadow,inset 0 1px 0 rgba(255,255,255,0.25)));}/*!sc*/ .jOdgLl:focus:not(:disabled){box-shadow:none;outline:2px solid var(--fgColor-accent,var(--color-accent-fg,#0969da));outline-offset:-2px;}/*!sc*/ .jOdgLl:focus:not(:disabled):not(:focus-visible){outline:solid 1px transparent;}/*!sc*/ .jOdgLl:focus-visible:not(:disabled){box-shadow:none;outline:2px solid var(--fgColor-accent,var(--color-accent-fg,#0969da));outline-offset:-2px;}/*!sc*/ .jOdgLl[href]{display:-webkit-inline-box;display:-webkit-inline-flex;display:-ms-inline-flexbox;display:inline-flex;}/*!sc*/ .jOdgLl[href]:hover{-webkit-text-decoration:none;text-decoration:none;}/*!sc*/ .jOdgLl:hover{-webkit-transition-duration:80ms;transition-duration:80ms;}/*!sc*/ .jOdgLl:active{-webkit-transition:none;transition:none;}/*!sc*/ .jOdgLl[data-inactive]{cursor:auto;}/*!sc*/ .jOdgLl:disabled{cursor:not-allowed;box-shadow:none;color:var(--fgColor-disabled,var(--color-primer-fg-disabled,#8c959f));border-color:var(--button-default-borderColor-disabled,var(--button-default-borderColor-rest,var(--color-btn-border,rgba(31,35,40,0.15))));background-color:var(--button-default-bgColor-disabled,var(--control-bgColor-disabled,var(--color-input-disabled-bg,rgba(175,184,193,0.2))));}/*!sc*/ .jOdgLl:disabled [data-component=ButtonCounter]{color:inherit;}/*!sc*/ @media (forced-colors:active){.jOdgLl:focus{outline:solid 1px transparent;}}/*!sc*/ .jOdgLl [data-component=ButtonCounter]{font-size:12px;background-color:var(--buttonCounter-default-bgColor-rest,var(--color-btn-counter-bg,rgba(31,35,40,0.08)));}/*!sc*/ .jOdgLl[data-component=IconButton]{display:inline-grid;padding:unset;place-content:center;width:32px;min-width:unset;}/*!sc*/ .jOdgLl[data-size="small"]{padding:0 8px;height:28px;gap:4px;font-size:12px;}/*!sc*/ .jOdgLl[data-size="small"] [data-component="text"]{line-height:calc(20 / 12);}/*!sc*/ .jOdgLl[data-size="small"] [data-component=ButtonCounter]{font-size:12px;}/*!sc*/ .jOdgLl[data-size="small"] [data-component="buttonContent"] > :not(:last-child){margin-right:4px;}/*!sc*/ .jOdgLl[data-size="small"][data-component=IconButton]{width:28px;padding:unset;}/*!sc*/ .jOdgLl[data-size="large"]{padding:0 16px;height:40px;gap:8px;}/*!sc*/ .jOdgLl[data-size="large"] [data-component="buttonContent"] > :not(:last-child){margin-right:8px;}/*!sc*/ .jOdgLl[data-size="large"][data-component=IconButton]{width:40px;padding:unset;}/*!sc*/ .jOdgLl[data-block="block"]{width:100%;}/*!sc*/ .jOdgLl[data-label-wrap="true"]{min-width:-webkit-fit-content;min-width:-moz-fit-content;min-width:fit-content;height:unset;min-height:var(--control-medium-size,2rem);}/*!sc*/ .jOdgLl[data-label-wrap="true"] [data-component="buttonContent"]{-webkit-flex:1 1 auto;-ms-flex:1 1 auto;flex:1 1 auto;-webkit-align-self:stretch;-ms-flex-item-align:stretch;align-self:stretch;padding-block:calc(var(--control-medium-paddingBlock,0.375rem) - 2px);}/*!sc*/ .jOdgLl[data-label-wrap="true"] [data-component="text"]{white-space:unset;word-break:break-word;}/*!sc*/ .jOdgLl[data-label-wrap="true"][data-size="small"]{height:unset;min-height:var(--control-small-size,1.75rem);}/*!sc*/ .jOdgLl[data-label-wrap="true"][data-size="small"] [data-component="buttonContent"]{padding-block:calc(var(--control-small-paddingBlock,0.25rem) - 2px);}/*!sc*/ .jOdgLl[data-label-wrap="true"][data-size="large"]{height:unset;min-height:var(--control-large-size,2.5rem);padding-inline:var(--control-large-paddingInline-spacious,1rem);}/*!sc*/ .jOdgLl[data-label-wrap="true"][data-size="large"] [data-component="buttonContent"]{padding-block:calc(var(--control-large-paddingBlock,0.625rem) - 2px);}/*!sc*/ .jOdgLl[data-inactive]:not([disabled]){background-color:var(--button-inactive-bgColor,var(--button-inactive-bgColor-rest,var(--color-btn-inactive-bg,#eaeef2)));border-color:var(--button-inactive-bgColor,var(--button-inactive-bgColor-rest,var(--color-btn-inactive-bg,#eaeef2)));color:var(--button-inactive-fgColor,var(--button-inactive-fgColor-rest,var(--color-btn-inactive-text,#57606a)));}/*!sc*/ .jOdgLl[data-inactive]:not([disabled]):focus-visible{box-shadow:none;}/*!sc*/ .jOdgLl [data-component="leadingVisual"]{grid-area:leadingVisual;}/*!sc*/ .jOdgLl [data-component="text"]{grid-area:text;line-height:calc(20/14);white-space:nowrap;}/*!sc*/ .jOdgLl [data-component="trailingVisual"]{grid-area:trailingVisual;}/*!sc*/ .jOdgLl [data-component="trailingAction"]{margin-right:-4px;}/*!sc*/ .jOdgLl [data-component="buttonContent"]{-webkit-flex:1 0 auto;-ms-flex:1 0 auto;flex:1 0 auto;display:grid;grid-template-areas:"leadingVisual text trailingVisual";grid-template-columns:min-content minmax(0,auto) min-content;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-align-content:center;-ms-flex-line-pack:center;align-content:center;}/*!sc*/ .jOdgLl [data-component="buttonContent"] > :not(:last-child){margin-right:8px;}/*!sc*/ .jOdgLl [data-component="loadingSpinner"]{grid-area:text;margin-right:0px !important;place-self:center;}/*!sc*/ .jOdgLl [data-component="loadingSpinner"] + [data-component="text"]{visibility:hidden;}/*!sc*/ .jOdgLl:hover:not([disabled]):not([data-inactive]){background-color:var(--button-default-bgColor-hover,var(--color-btn-hover-bg,#f3f4f6));border-color:var(--button-default-borderColor-hover,var(--button-default-borderColor-hover,var(--color-btn-hover-border,rgba(31,35,40,0.15))));}/*!sc*/ .jOdgLl:active:not([disabled]):not([data-inactive]){background-color:var(--button-default-bgColor-active,var(--color-btn-active-bg,hsla(220,14%,93%,1)));border-color:var(--button-default-borderColor-active,var(--button-default-borderColor-active,var(--color-btn-active-border,rgba(31,35,40,0.15))));}/*!sc*/ .jOdgLl[aria-expanded=true]{background-color:var(--button-default-bgColor-active,var(--color-btn-active-bg,hsla(220,14%,93%,1)));border-color:var(--button-default-borderColor-active,var(--button-default-borderColor-active,var(--color-btn-active-border,rgba(31,35,40,0.15))));}/*!sc*/ .jOdgLl [data-component="leadingVisual"],.jOdgLl [data-component="trailingVisual"],.jOdgLl [data-component="trailingAction"]{color:var(--button-color,var(--fgColor-muted,var(--color-fg-muted,#656d76)));}/*!sc*/ .jOdgLl[data-component="IconButton"][data-no-visuals]{color:var(--fgColor-muted,var(--color-fg-muted,#656d76));}/*!sc*/ .jOdgLl[data-no-visuals]{border-top-left-radius:unset;border-bottom-left-radius:unset;}/*!sc*/ .hmWbvh{border-radius:6px;border:1px solid;border-color:var(--button-default-borderColor-rest,var(--button-default-borderColor-rest,var(--color-btn-border,rgba(31,35,40,0.15))));font-family:inherit;font-weight:500;font-size:14px;cursor:pointer;-webkit-appearance:none;-moz-appearance:none;appearance:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-text-decoration:none;text-decoration:none;text-align:center;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;height:32px;padding:0 12px;gap:8px;min-width:-webkit-max-content;min-width:-moz-max-content;min-width:max-content;-webkit-transition:80ms cubic-bezier(0.65,0,0.35,1);transition:80ms cubic-bezier(0.65,0,0.35,1);-webkit-transition-property:color,fill,background-color,border-color;transition-property:color,fill,background-color,border-color;color:var(--button-default-fgColor-rest,var(--color-btn-text,#24292f));background-color:var(--button-default-bgColor-rest,var(--color-btn-bg,#f6f8fa));box-shadow:var(--button-default-shadow-resting,var(--color-btn-shadow,0 1px 0 rgba(31,35,40,0.04))),var(--button-default-shadow-inset,var(--color-btn-inset-shadow,inset 0 1px 0 rgba(255,255,255,0.25)));}/*!sc*/ .hmWbvh:focus:not(:disabled){box-shadow:none;outline:2px solid var(--fgColor-accent,var(--color-accent-fg,#0969da));outline-offset:-2px;}/*!sc*/ .hmWbvh:focus:not(:disabled):not(:focus-visible){outline:solid 1px transparent;}/*!sc*/ .hmWbvh:focus-visible:not(:disabled){box-shadow:none;outline:2px solid var(--fgColor-accent,var(--color-accent-fg,#0969da));outline-offset:-2px;}/*!sc*/ .hmWbvh[href]{display:-webkit-inline-box;display:-webkit-inline-flex;display:-ms-inline-flexbox;display:inline-flex;}/*!sc*/ .hmWbvh[href]:hover{-webkit-text-decoration:none;text-decoration:none;}/*!sc*/ .hmWbvh:hover{-webkit-transition-duration:80ms;transition-duration:80ms;}/*!sc*/ .hmWbvh:active{-webkit-transition:none;transition:none;}/*!sc*/ .hmWbvh[data-inactive]{cursor:auto;}/*!sc*/ .hmWbvh:disabled{cursor:not-allowed;box-shadow:none;color:var(--fgColor-disabled,var(--color-primer-fg-disabled,#8c959f));border-color:var(--button-default-borderColor-disabled,var(--button-default-borderColor-rest,var(--color-btn-border,rgba(31,35,40,0.15))));background-color:var(--button-default-bgColor-disabled,var(--control-bgColor-disabled,var(--color-input-disabled-bg,rgba(175,184,193,0.2))));}/*!sc*/ .hmWbvh:disabled [data-component=ButtonCounter]{color:inherit;}/*!sc*/ @media (forced-colors:active){.hmWbvh:focus{outline:solid 1px transparent;}}/*!sc*/ .hmWbvh [data-component=ButtonCounter]{font-size:12px;background-color:var(--buttonCounter-default-bgColor-rest,var(--color-btn-counter-bg,rgba(31,35,40,0.08)));}/*!sc*/ .hmWbvh[data-component=IconButton]{display:inline-grid;padding:unset;place-content:center;width:32px;min-width:unset;}/*!sc*/ .hmWbvh[data-size="small"]{padding:0 8px;height:28px;gap:4px;font-size:12px;}/*!sc*/ .hmWbvh[data-size="small"] [data-component="text"]{line-height:calc(20 / 12);}/*!sc*/ .hmWbvh[data-size="small"] [data-component=ButtonCounter]{font-size:12px;}/*!sc*/ .hmWbvh[data-size="small"] [data-component="buttonContent"] > :not(:last-child){margin-right:4px;}/*!sc*/ .hmWbvh[data-size="small"][data-component=IconButton]{width:28px;padding:unset;}/*!sc*/ .hmWbvh[data-size="large"]{padding:0 16px;height:40px;gap:8px;}/*!sc*/ .hmWbvh[data-size="large"] [data-component="buttonContent"] > :not(:last-child){margin-right:8px;}/*!sc*/ .hmWbvh[data-size="large"][data-component=IconButton]{width:40px;padding:unset;}/*!sc*/ .hmWbvh[data-block="block"]{width:100%;}/*!sc*/ .hmWbvh[data-label-wrap="true"]{min-width:-webkit-fit-content;min-width:-moz-fit-content;min-width:fit-content;height:unset;min-height:var(--control-medium-size,2rem);}/*!sc*/ .hmWbvh[data-label-wrap="true"] [data-component="buttonContent"]{-webkit-flex:1 1 auto;-ms-flex:1 1 auto;flex:1 1 auto;-webkit-align-self:stretch;-ms-flex-item-align:stretch;align-self:stretch;padding-block:calc(var(--control-medium-paddingBlock,0.375rem) - 2px);}/*!sc*/ .hmWbvh[data-label-wrap="true"] [data-component="text"]{white-space:unset;word-break:break-word;}/*!sc*/ .hmWbvh[data-label-wrap="true"][data-size="small"]{height:unset;min-height:var(--control-small-size,1.75rem);}/*!sc*/ .hmWbvh[data-label-wrap="true"][data-size="small"] [data-component="buttonContent"]{padding-block:calc(var(--control-small-paddingBlock,0.25rem) - 2px);}/*!sc*/ .hmWbvh[data-label-wrap="true"][data-size="large"]{height:unset;min-height:var(--control-large-size,2.5rem);padding-inline:var(--control-large-paddingInline-spacious,1rem);}/*!sc*/ .hmWbvh[data-label-wrap="true"][data-size="large"] [data-component="buttonContent"]{padding-block:calc(var(--control-large-paddingBlock,0.625rem) - 2px);}/*!sc*/ .hmWbvh[data-inactive]:not([disabled]){background-color:var(--button-inactive-bgColor,var(--button-inactive-bgColor-rest,var(--color-btn-inactive-bg,#eaeef2)));border-color:var(--button-inactive-bgColor,var(--button-inactive-bgColor-rest,var(--color-btn-inactive-bg,#eaeef2)));color:var(--button-inactive-fgColor,var(--button-inactive-fgColor-rest,var(--color-btn-inactive-text,#57606a)));}/*!sc*/ .hmWbvh[data-inactive]:not([disabled]):focus-visible{box-shadow:none;}/*!sc*/ .hmWbvh [data-component="leadingVisual"]{grid-area:leadingVisual;}/*!sc*/ .hmWbvh [data-component="text"]{grid-area:text;line-height:calc(20/14);white-space:nowrap;}/*!sc*/ .hmWbvh [data-component="trailingVisual"]{grid-area:trailingVisual;}/*!sc*/ .hmWbvh [data-component="trailingAction"]{margin-right:-4px;}/*!sc*/ .hmWbvh [data-component="buttonContent"]{-webkit-flex:1 0 auto;-ms-flex:1 0 auto;flex:1 0 auto;display:grid;grid-template-areas:"leadingVisual text trailingVisual";grid-template-columns:min-content minmax(0,auto) min-content;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-align-content:center;-ms-flex-line-pack:center;align-content:center;}/*!sc*/ .hmWbvh [data-component="buttonContent"] > :not(:last-child){margin-right:8px;}/*!sc*/ .hmWbvh [data-component="loadingSpinner"]{grid-area:text;margin-right:0px !important;place-self:center;}/*!sc*/ .hmWbvh [data-component="loadingSpinner"] + [data-component="text"]{visibility:hidden;}/*!sc*/ .hmWbvh:hover:not([disabled]):not([data-inactive]){background-color:var(--button-default-bgColor-hover,var(--color-btn-hover-bg,#f3f4f6));border-color:var(--button-default-borderColor-hover,var(--button-default-borderColor-hover,var(--color-btn-hover-border,rgba(31,35,40,0.15))));}/*!sc*/ .hmWbvh:active:not([disabled]):not([data-inactive]){background-color:var(--button-default-bgColor-active,var(--color-btn-active-bg,hsla(220,14%,93%,1)));border-color:var(--button-default-borderColor-active,var(--button-default-borderColor-active,var(--color-btn-active-border,rgba(31,35,40,0.15))));}/*!sc*/ .hmWbvh[aria-expanded=true]{background-color:var(--button-default-bgColor-active,var(--color-btn-active-bg,hsla(220,14%,93%,1)));border-color:var(--button-default-borderColor-active,var(--button-default-borderColor-active,var(--color-btn-active-border,rgba(31,35,40,0.15))));}/*!sc*/ .hmWbvh [data-component="leadingVisual"],.hmWbvh [data-component="trailingVisual"],.hmWbvh [data-component="trailingAction"]{color:var(--button-color,var(--fgColor-muted,var(--color-fg-muted,#656d76)));}/*!sc*/ .hmWbvh[data-component="IconButton"][data-no-visuals]{color:var(--fgColor-muted,var(--color-fg-muted,#656d76));}/*!sc*/ .lkeyoI{border-radius:6px;border:1px solid;border-color:var(--button-default-borderColor-rest,var(--button-default-borderColor-rest,var(--color-btn-border,rgba(31,35,40,0.15))));font-family:inherit;font-weight:500;font-size:14px;cursor:pointer;-webkit-appearance:none;-moz-appearance:none;appearance:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-text-decoration:none;text-decoration:none;text-align:center;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;height:32px;padding:0 12px;gap:8px;min-width:-webkit-max-content;min-width:-moz-max-content;min-width:max-content;-webkit-transition:80ms cubic-bezier(0.65,0,0.35,1);transition:80ms cubic-bezier(0.65,0,0.35,1);-webkit-transition-property:color,fill,background-color,border-color;transition-property:color,fill,background-color,border-color;color:var(--button-default-fgColor-rest,var(--color-btn-text,#24292f));background-color:var(--button-default-bgColor-rest,var(--color-btn-bg,#f6f8fa));box-shadow:var(--button-default-shadow-resting,var(--color-btn-shadow,0 1px 0 rgba(31,35,40,0.04))),var(--button-default-shadow-inset,var(--color-btn-inset-shadow,inset 0 1px 0 rgba(255,255,255,0.25)));}/*!sc*/ .lkeyoI:focus:not(:disabled){box-shadow:none;outline:2px solid var(--fgColor-accent,var(--color-accent-fg,#0969da));outline-offset:-2px;}/*!sc*/ .lkeyoI:focus:not(:disabled):not(:focus-visible){outline:solid 1px transparent;}/*!sc*/ .lkeyoI:focus-visible:not(:disabled){box-shadow:none;outline:2px solid var(--fgColor-accent,var(--color-accent-fg,#0969da));outline-offset:-2px;}/*!sc*/ .lkeyoI[href]{display:-webkit-inline-box;display:-webkit-inline-flex;display:-ms-inline-flexbox;display:inline-flex;}/*!sc*/ .lkeyoI[href]:hover{-webkit-text-decoration:none;text-decoration:none;}/*!sc*/ .lkeyoI:hover{-webkit-transition-duration:80ms;transition-duration:80ms;}/*!sc*/ .lkeyoI:active{-webkit-transition:none;transition:none;}/*!sc*/ .lkeyoI[data-inactive]{cursor:auto;}/*!sc*/ .lkeyoI:disabled{cursor:not-allowed;box-shadow:none;color:var(--fgColor-disabled,var(--color-primer-fg-disabled,#8c959f));border-color:var(--button-default-borderColor-disabled,var(--button-default-borderColor-rest,var(--color-btn-border,rgba(31,35,40,0.15))));background-color:var(--button-default-bgColor-disabled,var(--control-bgColor-disabled,var(--color-input-disabled-bg,rgba(175,184,193,0.2))));}/*!sc*/ .lkeyoI:disabled [data-component=ButtonCounter]{color:inherit;}/*!sc*/ @media (forced-colors:active){.lkeyoI:focus{outline:solid 1px transparent;}}/*!sc*/ .lkeyoI [data-component=ButtonCounter]{font-size:12px;background-color:var(--buttonCounter-default-bgColor-rest,var(--color-btn-counter-bg,rgba(31,35,40,0.08)));}/*!sc*/ .lkeyoI[data-component=IconButton]{display:inline-grid;padding:unset;place-content:center;width:32px;min-width:unset;}/*!sc*/ .lkeyoI[data-size="small"]{padding:0 8px;height:28px;gap:4px;font-size:12px;}/*!sc*/ .lkeyoI[data-size="small"] [data-component="text"]{line-height:calc(20 / 12);}/*!sc*/ .lkeyoI[data-size="small"] [data-component=ButtonCounter]{font-size:12px;}/*!sc*/ .lkeyoI[data-size="small"] [data-component="buttonContent"] > :not(:last-child){margin-right:4px;}/*!sc*/ .lkeyoI[data-size="small"][data-component=IconButton]{width:28px;padding:unset;}/*!sc*/ .lkeyoI[data-size="large"]{padding:0 16px;height:40px;gap:8px;}/*!sc*/ .lkeyoI[data-size="large"] [data-component="buttonContent"] > :not(:last-child){margin-right:8px;}/*!sc*/ .lkeyoI[data-size="large"][data-component=IconButton]{width:40px;padding:unset;}/*!sc*/ .lkeyoI[data-block="block"]{width:100%;}/*!sc*/ .lkeyoI[data-label-wrap="true"]{min-width:-webkit-fit-content;min-width:-moz-fit-content;min-width:fit-content;height:unset;min-height:var(--control-medium-size,2rem);}/*!sc*/ .lkeyoI[data-label-wrap="true"] [data-component="buttonContent"]{-webkit-flex:1 1 auto;-ms-flex:1 1 auto;flex:1 1 auto;-webkit-align-self:stretch;-ms-flex-item-align:stretch;align-self:stretch;padding-block:calc(var(--control-medium-paddingBlock,0.375rem) - 2px);}/*!sc*/ .lkeyoI[data-label-wrap="true"] [data-component="text"]{white-space:unset;word-break:break-word;}/*!sc*/ .lkeyoI[data-label-wrap="true"][data-size="small"]{height:unset;min-height:var(--control-small-size,1.75rem);}/*!sc*/ .lkeyoI[data-label-wrap="true"][data-size="small"] [data-component="buttonContent"]{padding-block:calc(var(--control-small-paddingBlock,0.25rem) - 2px);}/*!sc*/ .lkeyoI[data-label-wrap="true"][data-size="large"]{height:unset;min-height:var(--control-large-size,2.5rem);padding-inline:var(--control-large-paddingInline-spacious,1rem);}/*!sc*/ .lkeyoI[data-label-wrap="true"][data-size="large"] [data-component="buttonContent"]{padding-block:calc(var(--control-large-paddingBlock,0.625rem) - 2px);}/*!sc*/ .lkeyoI[data-inactive]:not([disabled]){background-color:var(--button-inactive-bgColor,var(--button-inactive-bgColor-rest,var(--color-btn-inactive-bg,#eaeef2)));border-color:var(--button-inactive-bgColor,var(--button-inactive-bgColor-rest,var(--color-btn-inactive-bg,#eaeef2)));color:var(--button-inactive-fgColor,var(--button-inactive-fgColor-rest,var(--color-btn-inactive-text,#57606a)));}/*!sc*/ .lkeyoI[data-inactive]:not([disabled]):focus-visible{box-shadow:none;}/*!sc*/ .lkeyoI [data-component="leadingVisual"]{grid-area:leadingVisual;}/*!sc*/ .lkeyoI [data-component="text"]{grid-area:text;line-height:calc(20/14);white-space:nowrap;}/*!sc*/ .lkeyoI [data-component="trailingVisual"]{grid-area:trailingVisual;}/*!sc*/ .lkeyoI [data-component="trailingAction"]{margin-right:-4px;}/*!sc*/ .lkeyoI [data-component="buttonContent"]{-webkit-flex:1 0 auto;-ms-flex:1 0 auto;flex:1 0 auto;display:grid;grid-template-areas:"leadingVisual text trailingVisual";grid-template-columns:min-content minmax(0,auto) min-content;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-align-content:center;-ms-flex-line-pack:center;align-content:center;}/*!sc*/ .lkeyoI [data-component="buttonContent"] > :not(:last-child){margin-right:8px;}/*!sc*/ .lkeyoI [data-component="loadingSpinner"]{grid-area:text;margin-right:0px !important;place-self:center;}/*!sc*/ .lkeyoI [data-component="loadingSpinner"] + [data-component="text"]{visibility:hidden;}/*!sc*/ .lkeyoI:hover:not([disabled]):not([data-inactive]){background-color:var(--button-default-bgColor-hover,var(--color-btn-hover-bg,#f3f4f6));border-color:var(--button-default-borderColor-hover,var(--button-default-borderColor-hover,var(--color-btn-hover-border,rgba(31,35,40,0.15))));}/*!sc*/ .lkeyoI:active:not([disabled]):not([data-inactive]){background-color:var(--button-default-bgColor-active,var(--color-btn-active-bg,hsla(220,14%,93%,1)));border-color:var(--button-default-borderColor-active,var(--button-default-borderColor-active,var(--color-btn-active-border,rgba(31,35,40,0.15))));}/*!sc*/ .lkeyoI[aria-expanded=true]{background-color:var(--button-default-bgColor-active,var(--color-btn-active-bg,hsla(220,14%,93%,1)));border-color:var(--button-default-borderColor-active,var(--button-default-borderColor-active,var(--color-btn-active-border,rgba(31,35,40,0.15))));}/*!sc*/ .lkeyoI [data-component="leadingVisual"],.lkeyoI [data-component="trailingVisual"],.lkeyoI [data-component="trailingAction"]{color:var(--button-color,var(--fgColor-muted,var(--color-fg-muted,#656d76)));}/*!sc*/ .lkeyoI[data-component="IconButton"][data-no-visuals]{color:var(--fgColor-muted,var(--color-fg-muted,#656d76));}/*!sc*/ .lkeyoI[data-no-visuals]{display:none;}/*!sc*/ .htZXvk{border-radius:6px;border:1px solid;border-color:var(--button-default-borderColor-rest,var(--button-default-borderColor-rest,var(--color-btn-border,rgba(31,35,40,0.15))));font-family:inherit;font-weight:500;font-size:14px;cursor:pointer;-webkit-appearance:none;-moz-appearance:none;appearance:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-text-decoration:none;text-decoration:none;text-align:center;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;height:32px;padding:0 12px;gap:8px;min-width:-webkit-max-content;min-width:-moz-max-content;min-width:max-content;-webkit-transition:80ms cubic-bezier(0.65,0,0.35,1);transition:80ms cubic-bezier(0.65,0,0.35,1);-webkit-transition-property:color,fill,background-color,border-color;transition-property:color,fill,background-color,border-color;color:var(--button-default-fgColor-rest,var(--color-btn-text,#24292f));background-color:var(--button-default-bgColor-rest,var(--color-btn-bg,#f6f8fa));box-shadow:var(--button-default-shadow-resting,var(--color-btn-shadow,0 1px 0 rgba(31,35,40,0.04))),var(--button-default-shadow-inset,var(--color-btn-inset-shadow,inset 0 1px 0 rgba(255,255,255,0.25)));}/*!sc*/ .htZXvk:focus:not(:disabled){box-shadow:none;outline:2px solid var(--fgColor-accent,var(--color-accent-fg,#0969da));outline-offset:-2px;}/*!sc*/ .htZXvk:focus:not(:disabled):not(:focus-visible){outline:solid 1px transparent;}/*!sc*/ .htZXvk:focus-visible:not(:disabled){box-shadow:none;outline:2px solid var(--fgColor-accent,var(--color-accent-fg,#0969da));outline-offset:-2px;}/*!sc*/ .htZXvk[href]{display:-webkit-inline-box;display:-webkit-inline-flex;display:-ms-inline-flexbox;display:inline-flex;}/*!sc*/ .htZXvk[href]:hover{-webkit-text-decoration:none;text-decoration:none;}/*!sc*/ .htZXvk:hover{-webkit-transition-duration:80ms;transition-duration:80ms;}/*!sc*/ .htZXvk:active{-webkit-transition:none;transition:none;}/*!sc*/ .htZXvk[data-inactive]{cursor:auto;}/*!sc*/ .htZXvk:disabled{cursor:not-allowed;box-shadow:none;color:var(--fgColor-disabled,var(--color-primer-fg-disabled,#8c959f));border-color:var(--button-default-borderColor-disabled,var(--button-default-borderColor-rest,var(--color-btn-border,rgba(31,35,40,0.15))));background-color:var(--button-default-bgColor-disabled,var(--control-bgColor-disabled,var(--color-input-disabled-bg,rgba(175,184,193,0.2))));}/*!sc*/ .htZXvk:disabled [data-component=ButtonCounter]{color:inherit;}/*!sc*/ @media (forced-colors:active){.htZXvk:focus{outline:solid 1px transparent;}}/*!sc*/ .htZXvk [data-component=ButtonCounter]{font-size:12px;background-color:var(--buttonCounter-default-bgColor-rest,var(--color-btn-counter-bg,rgba(31,35,40,0.08)));}/*!sc*/ .htZXvk[data-component=IconButton]{display:inline-grid;padding:unset;place-content:center;width:32px;min-width:unset;}/*!sc*/ .htZXvk[data-size="small"]{padding:0 8px;height:28px;gap:4px;font-size:12px;}/*!sc*/ .htZXvk[data-size="small"] [data-component="text"]{line-height:calc(20 / 12);}/*!sc*/ .htZXvk[data-size="small"] [data-component=ButtonCounter]{font-size:12px;}/*!sc*/ .htZXvk[data-size="small"] [data-component="buttonContent"] > :not(:last-child){margin-right:4px;}/*!sc*/ .htZXvk[data-size="small"][data-component=IconButton]{width:28px;padding:unset;}/*!sc*/ .htZXvk[data-size="large"]{padding:0 16px;height:40px;gap:8px;}/*!sc*/ .htZXvk[data-size="large"] [data-component="buttonContent"] > :not(:last-child){margin-right:8px;}/*!sc*/ .htZXvk[data-size="large"][data-component=IconButton]{width:40px;padding:unset;}/*!sc*/ .htZXvk[data-block="block"]{width:100%;}/*!sc*/ .htZXvk[data-label-wrap="true"]{min-width:-webkit-fit-content;min-width:-moz-fit-content;min-width:fit-content;height:unset;min-height:var(--control-medium-size,2rem);}/*!sc*/ .htZXvk[data-label-wrap="true"] [data-component="buttonContent"]{-webkit-flex:1 1 auto;-ms-flex:1 1 auto;flex:1 1 auto;-webkit-align-self:stretch;-ms-flex-item-align:stretch;align-self:stretch;padding-block:calc(var(--control-medium-paddingBlock,0.375rem) - 2px);}/*!sc*/ .htZXvk[data-label-wrap="true"] [data-component="text"]{white-space:unset;word-break:break-word;}/*!sc*/ .htZXvk[data-label-wrap="true"][data-size="small"]{height:unset;min-height:var(--control-small-size,1.75rem);}/*!sc*/ .htZXvk[data-label-wrap="true"][data-size="small"] [data-component="buttonContent"]{padding-block:calc(var(--control-small-paddingBlock,0.25rem) - 2px);}/*!sc*/ .htZXvk[data-label-wrap="true"][data-size="large"]{height:unset;min-height:var(--control-large-size,2.5rem);padding-inline:var(--control-large-paddingInline-spacious,1rem);}/*!sc*/ .htZXvk[data-label-wrap="true"][data-size="large"] [data-component="buttonContent"]{padding-block:calc(var(--control-large-paddingBlock,0.625rem) - 2px);}/*!sc*/ .htZXvk[data-inactive]:not([disabled]){background-color:var(--button-inactive-bgColor,var(--button-inactive-bgColor-rest,var(--color-btn-inactive-bg,#eaeef2)));border-color:var(--button-inactive-bgColor,var(--button-inactive-bgColor-rest,var(--color-btn-inactive-bg,#eaeef2)));color:var(--button-inactive-fgColor,var(--button-inactive-fgColor-rest,var(--color-btn-inactive-text,#57606a)));}/*!sc*/ .htZXvk[data-inactive]:not([disabled]):focus-visible{box-shadow:none;}/*!sc*/ .htZXvk [data-component="leadingVisual"]{grid-area:leadingVisual;}/*!sc*/ .htZXvk [data-component="text"]{grid-area:text;line-height:calc(20/14);white-space:nowrap;}/*!sc*/ .htZXvk [data-component="trailingVisual"]{grid-area:trailingVisual;}/*!sc*/ .htZXvk [data-component="trailingAction"]{margin-right:-4px;}/*!sc*/ .htZXvk [data-component="buttonContent"]{-webkit-flex:1 0 auto;-ms-flex:1 0 auto;flex:1 0 auto;display:grid;grid-template-areas:"leadingVisual text trailingVisual";grid-template-columns:min-content minmax(0,auto) min-content;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-align-content:center;-ms-flex-line-pack:center;align-content:center;}/*!sc*/ .htZXvk [data-component="buttonContent"] > :not(:last-child){margin-right:8px;}/*!sc*/ .htZXvk [data-component="loadingSpinner"]{grid-area:text;margin-right:0px !important;place-self:center;}/*!sc*/ .htZXvk [data-component="loadingSpinner"] + [data-component="text"]{visibility:hidden;}/*!sc*/ .htZXvk:hover:not([disabled]):not([data-inactive]){background-color:var(--button-default-bgColor-hover,var(--color-btn-hover-bg,#f3f4f6));border-color:var(--button-default-borderColor-hover,var(--button-default-borderColor-hover,var(--color-btn-hover-border,rgba(31,35,40,0.15))));}/*!sc*/ .htZXvk:active:not([disabled]):not([data-inactive]){background-color:var(--button-default-bgColor-active,var(--color-btn-active-bg,hsla(220,14%,93%,1)));border-color:var(--button-default-borderColor-active,var(--button-default-borderColor-active,var(--color-btn-active-border,rgba(31,35,40,0.15))));}/*!sc*/ .htZXvk[aria-expanded=true]{background-color:var(--button-default-bgColor-active,var(--color-btn-active-bg,hsla(220,14%,93%,1)));border-color:var(--button-default-borderColor-active,var(--button-default-borderColor-active,var(--color-btn-active-border,rgba(31,35,40,0.15))));}/*!sc*/ .htZXvk [data-component="leadingVisual"],.htZXvk [data-component="trailingVisual"],.htZXvk [data-component="trailingAction"]{color:var(--button-color,var(--fgColor-muted,var(--color-fg-muted,#656d76)));}/*!sc*/ .htZXvk[data-component="IconButton"][data-no-visuals]{color:var(--fgColor-muted,var(--color-fg-muted,#656d76));}/*!sc*/ .htZXvk[data-no-visuals]{margin-left:16px;}/*!sc*/ @media (min-width:768px){.htZXvk[data-no-visuals]{margin-left:0;}}/*!sc*/ @media (min-width:1012px){.htZXvk[data-no-visuals]{display:none;}}/*!sc*/ .jCopKa{border-radius:6px;border:1px solid;border-color:transparent;font-family:inherit;font-weight:500;font-size:14px;cursor:pointer;-webkit-appearance:none;-moz-appearance:none;appearance:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-text-decoration:none;text-decoration:none;text-align:center;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;height:32px;padding:0 12px;gap:8px;min-width:-webkit-max-content;min-width:-moz-max-content;min-width:max-content;-webkit-transition:80ms cubic-bezier(0.65,0,0.35,1);transition:80ms cubic-bezier(0.65,0,0.35,1);-webkit-transition-property:color,fill,background-color,border-color;transition-property:color,fill,background-color,border-color;color:var(--button-default-fgColor-rest,var(--color-btn-text,#24292f));background-color:transparent;box-shadow:none;}/*!sc*/ .jCopKa:focus:not(:disabled){box-shadow:none;outline:2px solid var(--fgColor-accent,var(--color-accent-fg,#0969da));outline-offset:-2px;}/*!sc*/ .jCopKa:focus:not(:disabled):not(:focus-visible){outline:solid 1px transparent;}/*!sc*/ .jCopKa:focus-visible:not(:disabled){box-shadow:none;outline:2px solid var(--fgColor-accent,var(--color-accent-fg,#0969da));outline-offset:-2px;}/*!sc*/ .jCopKa[href]{display:-webkit-inline-box;display:-webkit-inline-flex;display:-ms-inline-flexbox;display:inline-flex;}/*!sc*/ .jCopKa[href]:hover{-webkit-text-decoration:none;text-decoration:none;}/*!sc*/ .jCopKa:hover{-webkit-transition-duration:80ms;transition-duration:80ms;}/*!sc*/ .jCopKa:active{-webkit-transition:none;transition:none;}/*!sc*/ .jCopKa[data-inactive]{cursor:auto;}/*!sc*/ .jCopKa:disabled{cursor:not-allowed;box-shadow:none;color:var(--fgColor-disabled,var(--color-primer-fg-disabled,#8c959f));}/*!sc*/ .jCopKa:disabled [data-component=ButtonCounter],.jCopKa:disabled [data-component="leadingVisual"],.jCopKa:disabled [data-component="trailingAction"]{color:inherit;}/*!sc*/ @media (forced-colors:active){.jCopKa:focus{outline:solid 1px transparent;}}/*!sc*/ .jCopKa [data-component=ButtonCounter]{font-size:12px;}/*!sc*/ .jCopKa[data-component=IconButton]{display:inline-grid;padding:unset;place-content:center;width:32px;min-width:unset;}/*!sc*/ .jCopKa[data-size="small"]{padding:0 8px;height:28px;gap:4px;font-size:12px;}/*!sc*/ .jCopKa[data-size="small"] [data-component="text"]{line-height:calc(20 / 12);}/*!sc*/ .jCopKa[data-size="small"] [data-component=ButtonCounter]{font-size:12px;}/*!sc*/ .jCopKa[data-size="small"] [data-component="buttonContent"] > :not(:last-child){margin-right:4px;}/*!sc*/ .jCopKa[data-size="small"][data-component=IconButton]{width:28px;padding:unset;}/*!sc*/ .jCopKa[data-size="large"]{padding:0 16px;height:40px;gap:8px;}/*!sc*/ .jCopKa[data-size="large"] [data-component="buttonContent"] > :not(:last-child){margin-right:8px;}/*!sc*/ .jCopKa[data-size="large"][data-component=IconButton]{width:40px;padding:unset;}/*!sc*/ .jCopKa[data-block="block"]{width:100%;}/*!sc*/ .jCopKa[data-label-wrap="true"]{min-width:-webkit-fit-content;min-width:-moz-fit-content;min-width:fit-content;height:unset;min-height:var(--control-medium-size,2rem);}/*!sc*/ .jCopKa[data-label-wrap="true"] [data-component="buttonContent"]{-webkit-flex:1 1 auto;-ms-flex:1 1 auto;flex:1 1 auto;-webkit-align-self:stretch;-ms-flex-item-align:stretch;align-self:stretch;padding-block:calc(var(--control-medium-paddingBlock,0.375rem) - 2px);}/*!sc*/ .jCopKa[data-label-wrap="true"] [data-component="text"]{white-space:unset;word-break:break-word;}/*!sc*/ .jCopKa[data-label-wrap="true"][data-size="small"]{height:unset;min-height:var(--control-small-size,1.75rem);}/*!sc*/ .jCopKa[data-label-wrap="true"][data-size="small"] [data-component="buttonContent"]{padding-block:calc(var(--control-small-paddingBlock,0.25rem) - 2px);}/*!sc*/ .jCopKa[data-label-wrap="true"][data-size="large"]{height:unset;min-height:var(--control-large-size,2.5rem);padding-inline:var(--control-large-paddingInline-spacious,1rem);}/*!sc*/ .jCopKa[data-label-wrap="true"][data-size="large"] [data-component="buttonContent"]{padding-block:calc(var(--control-large-paddingBlock,0.625rem) - 2px);}/*!sc*/ .jCopKa[data-inactive]:not([disabled]){background-color:var(--button-inactive-bgColor,var(--button-inactive-bgColor-rest,var(--color-btn-inactive-bg,#eaeef2)));border-color:var(--button-inactive-bgColor,var(--button-inactive-bgColor-rest,var(--color-btn-inactive-bg,#eaeef2)));color:var(--button-inactive-fgColor,var(--button-inactive-fgColor-rest,var(--color-btn-inactive-text,#57606a)));}/*!sc*/ .jCopKa[data-inactive]:not([disabled]):focus-visible{box-shadow:none;}/*!sc*/ .jCopKa [data-component="leadingVisual"]{grid-area:leadingVisual;color:var(--fgColor-muted,var(--color-fg-muted,#656d76));}/*!sc*/ .jCopKa [data-component="text"]{grid-area:text;line-height:calc(20/14);white-space:nowrap;}/*!sc*/ .jCopKa [data-component="trailingVisual"]{grid-area:trailingVisual;}/*!sc*/ .jCopKa [data-component="trailingAction"]{margin-right:-4px;color:var(--fgColor-muted,var(--color-fg-muted,#656d76));}/*!sc*/ .jCopKa [data-component="buttonContent"]{-webkit-flex:1 0 auto;-ms-flex:1 0 auto;flex:1 0 auto;display:grid;grid-template-areas:"leadingVisual text trailingVisual";grid-template-columns:min-content minmax(0,auto) min-content;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-align-content:center;-ms-flex-line-pack:center;align-content:center;}/*!sc*/ .jCopKa [data-component="buttonContent"] > :not(:last-child){margin-right:8px;}/*!sc*/ .jCopKa [data-component="loadingSpinner"]{grid-area:text;margin-right:0px !important;place-self:center;}/*!sc*/ .jCopKa [data-component="loadingSpinner"] + [data-component="text"]{visibility:hidden;}/*!sc*/ .jCopKa:hover:not([disabled]){background-color:var(--control-transparent-bgColor-hover,var(--color-action-list-item-default-hover-bg,rgba(208,215,222,0.32)));}/*!sc*/ .jCopKa:active:not([disabled]){background-color:var(--control-transparent-bgColor-active,var(--color-action-list-item-default-active-bg,rgba(208,215,222,0.48)));}/*!sc*/ .jCopKa[aria-expanded=true]{background-color:var(--control-transparent-bgColor-selected,var(--color-action-list-item-default-selected-bg,rgba(208,215,222,0.24)));}/*!sc*/ .jCopKa[data-component="IconButton"][data-no-visuals]{color:var(--fgColor-muted,var(--color-fg-muted,#656d76));}/*!sc*/ .jCopKa[data-no-visuals]{color:var(--fgColor-accent,var(--color-accent-fg,#0969da));}/*!sc*/ .jCopKa:has([data-component="ButtonCounter"]){color:var(--button-default-fgColor-rest,var(--color-btn-text,#24292f));}/*!sc*/ .jCopKa:disabled[data-no-visuals]{color:var(--fgColor-disabled,var(--color-primer-fg-disabled,#8c959f));}/*!sc*/ .jCopKa:disabled[data-no-visuals] [data-component=ButtonCounter]{color:inherit;}/*!sc*/ data-styled.g4[id="types__StyledButton-sc-ws60qy-0"]{content:"hXCKEr,jOdgLl,hmWbvh,lkeyoI,htZXvk,jCopKa,"}/*!sc*/ .eiGLpS{display:none;}/*!sc*/ .eiGLpS[popover]{position:absolute;padding:0.5em 0.75em;width:-webkit-max-content;width:-moz-max-content;width:max-content;margin:auto;-webkit-clip:auto;clip:auto;white-space:normal;font:normal normal 11px/1.5 -apple-system,BlinkMacSystemFont,"Segoe UI","Noto Sans",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji";-webkit-font-smoothing:subpixel-antialiased;color:var(--fgColor-onEmphasis,var(--color-fg-on-emphasis,#ffffff));text-align:center;word-wrap:break-word;background:var(--bgColor-emphasis,var(--color-neutral-emphasis-plus,#24292f));border-radius:6px;border:0;opacity:0;max-width:250px;inset:auto;overflow:visible;}/*!sc*/ .eiGLpS[popover]:popover-open{display:block;}/*!sc*/ .eiGLpS[popover].\:popover-open{display:block;}/*!sc*/ @media (forced-colors:active){.eiGLpS{outline:1px solid transparent;}}/*!sc*/ .eiGLpS::after{position:absolute;display:block;right:0;left:0;height:var(--overlay-offset,0.25rem);content:'';}/*!sc*/ .eiGLpS[data-direction='n']::after,.eiGLpS[data-direction='ne']::after,.eiGLpS[data-direction='nw']::after{top:100%;}/*!sc*/ .eiGLpS[data-direction='s']::after,.eiGLpS[data-direction='se']::after,.eiGLpS[data-direction='sw']::after{bottom:100%;}/*!sc*/ .eiGLpS[data-direction='w']::after{position:absolute;display:block;height:100%;width:8px;content:'';bottom:0;left:100%;}/*!sc*/ .eiGLpS[data-direction='e']::after{position:absolute;display:block;height:100%;width:8px;content:'';bottom:0;right:100%;margin-left:-8px;}/*!sc*/ @-webkit-keyframes tooltip-appear{from{opacity:0;}to{opacity:1;}}/*!sc*/ @keyframes tooltip-appear{from{opacity:0;}to{opacity:1;}}/*!sc*/ .eiGLpS:popover-open,.eiGLpS:popover-open::before{-webkit-animation-name:tooltip-appear;animation-name:tooltip-appear;-webkit-animation-duration:0.1s;animation-duration:0.1s;-webkit-animation-fill-mode:forwards;animation-fill-mode:forwards;-webkit-animation-timing-function:ease-in;animation-timing-function:ease-in;-webkit-animation-delay:0s;animation-delay:0s;}/*!sc*/ .eiGLpS.\:popover-open,.eiGLpS.\:popover-open::before{-webkit-animation-name:tooltip-appear;animation-name:tooltip-appear;-webkit-animation-duration:0.1s;animation-duration:0.1s;-webkit-animation-fill-mode:forwards;animation-fill-mode:forwards;-webkit-animation-timing-function:ease-in;animation-timing-function:ease-in;-webkit-animation-delay:0s;animation-delay:0s;}/*!sc*/ data-styled.g8[id="Tooltip__StyledTooltip-sc-e45c7z-0"]{content:"eiGLpS,"}/*!sc*/ .daAEFx{-webkit-transform:rotate(0deg);-ms-transform:rotate(0deg);transform:rotate(0deg);}/*!sc*/ data-styled.g11[id="Octicon-sc-9kayk9-0"]{content:"daAEFx,"}/*!sc*/ .bebFBv{font-weight:600;font-size:32px;margin:0;font-size:14px;}/*!sc*/ @media (min-width:1012px) and (max-width:1400px){.bebFBv{margin-top:2rem;}}/*!sc*/ data-styled.g28[id="Heading__StyledHeading-sc-1c1dgg0-0"]{content:"bebFBv,"}/*!sc*/ .hgjakc{margin:0;padding-inline-start:0;padding-top:8px;padding-bottom:8px;}/*!sc*/ data-styled.g29[id="List__ListBox-sc-1x7olzq-0"]{content:"hgjakc,"}/*!sc*/ .lnYQME{position:relative;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;padding-left:0;padding-right:0;font-size:14px;padding-top:0;padding-bottom:0;line-height:20px;min-height:5px;margin-left:8px;margin-right:8px;border-radius:6px;-webkit-transition:background 33.333ms linear;transition:background 33.333ms linear;color:var(--fgColor-default,var(--color-fg-default,#1F2328));cursor:pointer;-webkit-appearance:none;-moz-appearance:none;appearance:none;background:unset;border:unset;width:calc(100% - 16px);font-family:unset;text-align:unset;margin-top:unset;margin-bottom:unset;}/*!sc*/ .lnYQME[data-loading]{cursor:default;}/*!sc*/ .lnYQME[aria-disabled],.lnYQME[data-inactive]{cursor:not-allowed;}/*!sc*/ .lnYQME[aria-disabled] [data-component="ActionList.Checkbox"],.lnYQME[data-inactive] [data-component="ActionList.Checkbox"]{cursor:not-allowed;background-color:var(--color-input-disabled-bg,rgba(175,184,193,0.2));border-color:var(--color-input-disabled-bg,rgba(175,184,193,0.2));}/*!sc*/ @media (forced-colors:active){.lnYQME:focus,.lnYQME:focus-visible,.lnYQME > a.focus-visible{outline:solid 1px transparent !important;}}/*!sc*/ .lnYQME [data-component="ActionList.Item--DividerContainer"]{position:relative;}/*!sc*/ .lnYQME [data-component="ActionList.Item--DividerContainer"]::before{content:" ";display:block;position:absolute;width:100%;top:-7px;border:0 solid;border-top-width:0;border-color:var(--divider-color,transparent);}/*!sc*/ .lnYQME:not(:first-of-type){--divider-color:var(--borderColor-muted,var(--color-action-list-item-inline-divider,rgba(208,215,222,0.48)));}/*!sc*/ [data-component="ActionList.Divider"] + .Item__LiBox-sc-yeql7o-0{--divider-color:transparent !important;}/*!sc*/ .lnYQME:hover:not([aria-disabled]):not([data-inactive]):not([data-loading]),.lnYQME[data-focus-visible-added]:not([aria-disabled]):not([data-inactive]){--divider-color:transparent;}/*!sc*/ .lnYQME:hover:not([aria-disabled]):not([data-inactive]):not([data-loading]) + .Item__LiBox-sc-yeql7o-0,.lnYQME[data-focus-visible-added] + li{--divider-color:transparent;}/*!sc*/ @media (hover:hover) and (pointer:fine){.lnYQME:hover:not([aria-disabled]):not([data-inactive]){background-color:var(--control-transparent-bgColor-hover,var(--color-action-list-item-default-hover-bg,rgba(208,215,222,0.32)));color:var(--fgColor-default,var(--color-fg-default,#1F2328));box-shadow:inset 0 0 0 max(1px,0.0625rem) var(--control-transparent-borderColor-active,var(--color-action-list-item-default-active-border,transparent));}.lnYQME:focus-visible,.lnYQME > a.focus-visible,.lnYQME:focus.focus-visible{outline:none;border:2 solid;box-shadow:0 0 0 2px var(--bgColor-accent-emphasis,var(--color-accent-emphasis,#0969da));}.lnYQME:active:not([aria-disabled]):not([data-inactive]){background-color:var(--control-transparent-bgColor-active,var(--color-action-list-item-default-active-bg,rgba(208,215,222,0.48)));color:var(--fgColor-default,var(--color-fg-default,#1F2328));}}/*!sc*/ .hTSEii{position:relative;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;padding-left:0;padding-right:0;font-size:14px;padding-top:0;padding-bottom:0;line-height:20px;min-height:5px;margin-left:8px;margin-right:8px;border-radius:6px;-webkit-transition:background 33.333ms linear;transition:background 33.333ms linear;color:var(--fgColor-default,var(--color-fg-default,#1F2328));cursor:pointer;-webkit-appearance:none;-moz-appearance:none;appearance:none;background:unset;border:unset;width:calc(100% - 16px);font-family:unset;text-align:unset;margin-top:unset;margin-bottom:unset;font-weight:600;background-color:var(--control-transparent-bgColor-selected,var(--color-action-list-item-default-selected-bg,rgba(208,215,222,0.24)));}/*!sc*/ .hTSEii[data-loading]{cursor:default;}/*!sc*/ .hTSEii[aria-disabled],.hTSEii[data-inactive]{cursor:not-allowed;}/*!sc*/ .hTSEii[aria-disabled] [data-component="ActionList.Checkbox"],.hTSEii[data-inactive] [data-component="ActionList.Checkbox"]{cursor:not-allowed;background-color:var(--color-input-disabled-bg,rgba(175,184,193,0.2));border-color:var(--color-input-disabled-bg,rgba(175,184,193,0.2));}/*!sc*/ @media (forced-colors:active){.hTSEii:focus,.hTSEii:focus-visible,.hTSEii > a.focus-visible{outline:solid 1px transparent !important;}}/*!sc*/ .hTSEii [data-component="ActionList.Item--DividerContainer"]{position:relative;}/*!sc*/ .hTSEii [data-component="ActionList.Item--DividerContainer"]::before{content:" ";display:block;position:absolute;width:100%;top:-7px;border:0 solid;border-top-width:0;border-color:var(--divider-color,transparent);}/*!sc*/ .hTSEii:not(:first-of-type){--divider-color:var(--borderColor-muted,var(--color-action-list-item-inline-divider,rgba(208,215,222,0.48)));}/*!sc*/ [data-component="ActionList.Divider"] + .Item__LiBox-sc-yeql7o-0{--divider-color:transparent !important;}/*!sc*/ .hTSEii:hover:not([aria-disabled]):not([data-inactive]):not([data-loading]),.hTSEii[data-focus-visible-added]:not([aria-disabled]):not([data-inactive]){--divider-color:transparent;}/*!sc*/ .hTSEii:hover:not([aria-disabled]):not([data-inactive]):not([data-loading]) + .Item__LiBox-sc-yeql7o-0,.hTSEii[data-focus-visible-added] + li{--divider-color:transparent;}/*!sc*/ .hTSEii::after{position:absolute;top:calc(50% - 12px);left:-8px;width:4px;height:24px;content:"";background-color:var(--fgColor-accent,var(--color-accent-fg,#0969da));border-radius:6px;}/*!sc*/ @media (hover:hover) and (pointer:fine){.hTSEii:hover:not([aria-disabled]):not([data-inactive]){background-color:var(--control-transparent-bgColor-hover,var(--color-action-list-item-default-hover-bg,rgba(208,215,222,0.32)));color:var(--fgColor-default,var(--color-fg-default,#1F2328));box-shadow:inset 0 0 0 max(1px,0.0625rem) var(--control-transparent-borderColor-active,var(--color-action-list-item-default-active-border,transparent));}.hTSEii:focus-visible,.hTSEii > a.focus-visible,.hTSEii:focus.focus-visible{outline:none;border:2 solid;box-shadow:0 0 0 2px var(--bgColor-accent-emphasis,var(--color-accent-emphasis,#0969da));}.hTSEii:active:not([aria-disabled]):not([data-inactive]){background-color:var(--control-transparent-bgColor-active,var(--color-action-list-item-default-active-bg,rgba(208,215,222,0.48)));color:var(--fgColor-default,var(--color-fg-default,#1F2328));}}/*!sc*/ .itjSOb{position:relative;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;padding-left:8px;padding-right:8px;padding-top:6px;padding-bottom:6px;line-height:20px;min-height:5px;margin-left:8px;margin-right:8px;border-radius:6px;-webkit-transition:background 33.333ms linear;transition:background 33.333ms linear;color:var(--fgColor-default,var(--color-fg-default,#1F2328));cursor:pointer;-webkit-appearance:none;-moz-appearance:none;appearance:none;background:unset;border:unset;width:calc(100% - 16px);font-family:unset;text-align:unset;margin-top:unset;margin-bottom:unset;}/*!sc*/ .itjSOb[data-loading]{cursor:default;}/*!sc*/ .itjSOb[aria-disabled],.itjSOb[data-inactive]{cursor:not-allowed;}/*!sc*/ .itjSOb[aria-disabled] [data-component="ActionList.Checkbox"],.itjSOb[data-inactive] [data-component="ActionList.Checkbox"]{cursor:not-allowed;background-color:var(--color-input-disabled-bg,rgba(175,184,193,0.2));border-color:var(--color-input-disabled-bg,rgba(175,184,193,0.2));}/*!sc*/ @media (forced-colors:active){.itjSOb:focus,.itjSOb:focus-visible,.itjSOb > a.focus-visible{outline:solid 1px transparent !important;}}/*!sc*/ .itjSOb [data-component="ActionList.Item--DividerContainer"]{position:relative;}/*!sc*/ .itjSOb [data-component="ActionList.Item--DividerContainer"]::before{content:" ";display:block;position:absolute;width:100%;top:-7px;border:0 solid;border-top-width:0;border-color:var(--divider-color,transparent);}/*!sc*/ .itjSOb:not(:first-of-type){--divider-color:var(--borderColor-muted,var(--color-action-list-item-inline-divider,rgba(208,215,222,0.48)));}/*!sc*/ [data-component="ActionList.Divider"] + .Item__LiBox-sc-yeql7o-0{--divider-color:transparent !important;}/*!sc*/ .itjSOb:hover:not([aria-disabled]):not([data-inactive]):not([data-loading]),.itjSOb[data-focus-visible-added]:not([aria-disabled]):not([data-inactive]){--divider-color:transparent;}/*!sc*/ .itjSOb:hover:not([aria-disabled]):not([data-inactive]):not([data-loading]) + .Item__LiBox-sc-yeql7o-0,.itjSOb[data-focus-visible-added] + li{--divider-color:transparent;}/*!sc*/ @media (hover:hover) and (pointer:fine){.itjSOb:hover:not([aria-disabled]):not([data-inactive]){background-color:var(--control-transparent-bgColor-hover,var(--color-action-list-item-default-hover-bg,rgba(208,215,222,0.32)));color:var(--fgColor-default,var(--color-fg-default,#1F2328));box-shadow:inset 0 0 0 max(1px,0.0625rem) var(--control-transparent-borderColor-active,var(--color-action-list-item-default-active-border,transparent));}.itjSOb:focus-visible,.itjSOb > a.focus-visible,.itjSOb:focus.focus-visible{outline:none;border:2 solid;box-shadow:0 0 0 2px var(--bgColor-accent-emphasis,var(--color-accent-emphasis,#0969da));}.itjSOb:active:not([aria-disabled]):not([data-inactive]){background-color:var(--control-transparent-bgColor-active,var(--color-action-list-item-default-active-bg,rgba(208,215,222,0.48)));color:var(--fgColor-default,var(--color-fg-default,#1F2328));}}/*!sc*/ data-styled.g31[id="Item__LiBox-sc-yeql7o-0"]{content:"lnYQME,hTSEii,itjSOb,"}/*!sc*/ .cJbOew{color:var(--fgColor-accent,var(--color-accent-fg,#0969da));-webkit-text-decoration:none;text-decoration:none;padding-left:8px;padding-right:8px;padding-top:6px;padding-bottom:6px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-flex:1;-webkit-flex-grow:1;-ms-flex-positive:1;flex-grow:1;border-radius:6px;color:inherit;}/*!sc*/ [data-a11y-link-underlines='true'] .Link__StyledLink-sc-14289xe-0[data-inline='true']{-webkit-text-decoration:underline;text-decoration:underline;}/*!sc*/ .cJbOew:hover{-webkit-text-decoration:underline;text-decoration:underline;}/*!sc*/ .cJbOew:is(button){display:inline-block;padding:0;font-size:inherit;white-space:nowrap;cursor:pointer;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;background-color:transparent;border:0;-webkit-appearance:none;-moz-appearance:none;appearance:none;}/*!sc*/ .cJbOew:hover{color:inherit;-webkit-text-decoration:none;text-decoration:none;}/*!sc*/ .fuIgwR{color:var(--fgColor-accent,var(--color-accent-fg,#0969da));-webkit-text-decoration:none;text-decoration:none;padding-left:16px;padding-right:8px;padding-top:6px;padding-bottom:6px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-flex:1;-webkit-flex-grow:1;-ms-flex-positive:1;flex-grow:1;border-radius:6px;color:inherit;font-size:12px;font-weight:400;}/*!sc*/ [data-a11y-link-underlines='true'] .Link__StyledLink-sc-14289xe-0[data-inline='true']{-webkit-text-decoration:underline;text-decoration:underline;}/*!sc*/ .fuIgwR:hover{-webkit-text-decoration:underline;text-decoration:underline;}/*!sc*/ .fuIgwR:is(button){display:inline-block;padding:0;font-size:inherit;white-space:nowrap;cursor:pointer;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;background-color:transparent;border:0;-webkit-appearance:none;-moz-appearance:none;appearance:none;}/*!sc*/ .fuIgwR:hover{color:inherit;-webkit-text-decoration:none;text-decoration:none;}/*!sc*/ data-styled.g32[id="Link__StyledLink-sc-14289xe-0"]{content:"cJbOew,fuIgwR,"}/*!sc*/ .cnCOhW{font-size:14px;line-height:20px;color:var(--fgColor-default,var(--color-fg-default,#1F2328));vertical-align:middle;background-color:var(--bgColor-default,var(--color-canvas-default,#ffffff));border:1px solid var(--control-borderColor-rest,var(--borderColor-default,var(--color-border-default,#d0d7de)));border-radius:6px;outline:none;box-shadow:var(--shadow-inset,var(--color-primer-shadow-inset,inset 0 1px 0 rgba(208,215,222,0.2)));display:-webkit-inline-box;display:-webkit-inline-flex;display:-ms-inline-flexbox;display:inline-flex;-webkit-align-items:stretch;-webkit-box-align:stretch;-ms-flex-align:stretch;align-items:stretch;min-height:32px;overflow:hidden;width:100%;height:2rem;-webkit-transition:width 0.3s ease-in-out;transition:width 0.3s ease-in-out;border-bottom-right-radius:unset;border-top-right-radius:unset;border-right:none;min-width:15rem;}/*!sc*/ .cnCOhW input,.cnCOhW textarea{cursor:text;}/*!sc*/ .cnCOhW select{cursor:pointer;}/*!sc*/ .cnCOhW input::-webkit-input-placeholder,.cnCOhW textarea::-webkit-input-placeholder,.cnCOhW select::-webkit-input-placeholder{color:var(---control-fgColor-placeholder,var(--fgColor-muted,var(--color-fg-muted,#656d76)));}/*!sc*/ .cnCOhW input::-moz-placeholder,.cnCOhW textarea::-moz-placeholder,.cnCOhW select::-moz-placeholder{color:var(---control-fgColor-placeholder,var(--fgColor-muted,var(--color-fg-muted,#656d76)));}/*!sc*/ .cnCOhW input:-ms-input-placeholder,.cnCOhW textarea:-ms-input-placeholder,.cnCOhW select:-ms-input-placeholder{color:var(---control-fgColor-placeholder,var(--fgColor-muted,var(--color-fg-muted,#656d76)));}/*!sc*/ .cnCOhW input::placeholder,.cnCOhW textarea::placeholder,.cnCOhW select::placeholder{color:var(---control-fgColor-placeholder,var(--fgColor-muted,var(--color-fg-muted,#656d76)));}/*!sc*/ .cnCOhW:focus-within{border-color:var(--fgColor-accent,var(--color-accent-fg,#0969da));outline:2px solid var(--fgColor-accent,var(--color-accent-fg,#0969da));outline-offset:-1px;}/*!sc*/ .cnCOhW > textarea{padding:12px;}/*!sc*/ @media (min-width:768px){.cnCOhW{font-size:14px;}}/*!sc*/ data-styled.g34[id="TextInputWrapper__TextInputBaseWrapper-sc-1mqhpbi-0"]{content:"cnCOhW,"}/*!sc*/ .hmJNAM{background-repeat:no-repeat;background-position:right 8px center;padding-left:0;padding-right:0;width:100%;height:2rem;-webkit-transition:width 0.3s ease-in-out;transition:width 0.3s ease-in-out;border-bottom-right-radius:unset;border-top-right-radius:unset;border-right:none;min-width:15rem;}/*!sc*/ .hmJNAM > :not(:last-child){margin-right:8px;}/*!sc*/ .hmJNAM .TextInput-icon,.hmJNAM .TextInput-action{-webkit-align-self:center;-ms-flex-item-align:center;align-self:center;color:var(--fgColor-muted,var(--color-fg-muted,#656d76));-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}/*!sc*/ .hmJNAM > input,.hmJNAM > select{padding-left:12px;padding-right:12px;}/*!sc*/ data-styled.g35[id="TextInputWrapper-sc-1mqhpbi-1"]{content:"hmJNAM,"}/*!sc*/ .jvumlb{border:0;font-size:inherit;font-family:inherit;background-color:transparent;-webkit-appearance:none;color:inherit;width:100%;}/*!sc*/ .jvumlb:focus{outline:0;}/*!sc*/ data-styled.g36[id="UnstyledTextInput-sc-14ypya-0"]{content:"jvumlb,"}/*!sc*/ </style></head><body><div id="__next"><a href="#main-content" class="visually-hidden skip-button color-bg-accent-emphasis color-fg-on-emphasis">Skip to main content</a><div data-container="header" class="border-bottom d-unset color-border-muted no-print z-3 color-bg-default Header_header__frpqb"><div data-container="notifications"></div><header class="color-bg-default p-2 position-sticky top-0 z-1 border-bottom" role="banner" aria-label="Main"><div class="d-flex flex-justify-between p-2 flex-items-center flex-wrap" style="row-gap:1rem" data-testid="desktop-header"><div tabindex="-1" class="Header_logoWithClosedSearch__zhF6Q" id="github-logo"><a rel="" class="d-flex flex-items-center color-fg-default no-underline mr-3" href="/en"><svg aria-hidden="true" focusable="false" class="octicon octicon-mark-github" viewBox="0 0 24 24" width="32" height="32" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="M12.5.75C6.146.75 1 5.896 1 12.25c0 5.089 3.292 9.387 7.863 10.91.575.101.79-.244.79-.546 0-.273-.014-1.178-.014-2.142-2.889.532-3.636-.704-3.866-1.35-.13-.331-.69-1.352-1.18-1.625-.402-.216-.977-.748-.014-.762.906-.014 1.553.834 1.769 1.179 1.035 1.74 2.688 1.25 3.349.948.1-.747.402-1.25.733-1.538-2.559-.287-5.232-1.279-5.232-5.678 0-1.25.445-2.285 1.178-3.09-.115-.288-.517-1.467.115-3.048 0 0 .963-.302 3.163 1.179.92-.259 1.897-.388 2.875-.388.977 0 1.955.13 2.875.388 2.2-1.495 3.162-1.179 3.162-1.179.633 1.581.23 2.76.115 3.048.733.805 1.179 1.825 1.179 3.09 0 4.413-2.688 5.39-5.247 5.678.417.36.776 1.05.776 2.128 0 1.538-.014 2.774-.014 3.162 0 .302.216.662.79.547C20.709 21.637 24 17.324 24 12.25 24 5.896 18.854.75 12.5.75Z"></path></svg><span class="h4 text-semibold ml-2 mr-3">GitHub Docs</span></a><div class="hide-sm border-left pl-3"><div data-testid="version-picker" class=""><button type="button" aria-label="Select GitHub product version: current version is free-pro-team@latest" class="types__StyledButton-sc-ws60qy-0 hXCKEr color-fg-default width-full p-1 pl-2 pr-2" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Ripn6:-loading-announcement" id=":Ripn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text"><span style="white-space:pre-wrap">Version: </span><span class="f5 color-fg-muted text-normal" data-testid="field">Free, Pro, &amp; Team</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div></div><div class="d-flex flex-items-center"><div class="OldHeaderSearchAndWidgets_searchContainerWithClosedSearch__Lkq6t mr-3"><div data-testid="search"><div class="position-relative z-2"><form role="search" class="width-full d-flex"><meta name="viewport" content="width=device-width initial-scale=1"/><label class="text-normal width-full"><span class="visually-hidden" aria-describedby="Enter a search term to find it in the GitHub Docs.">Search GitHub Docs</span><span class="TextInputWrapper__TextInputBaseWrapper-sc-1mqhpbi-0 TextInputWrapper-sc-1mqhpbi-1 cnCOhW hmJNAM TextInput-wrapper" aria-busy="false"><input type="search" aria-required="true" data-testid="site-search-input" placeholder="Search GitHub Docs" autoComplete="off" autoCorrect="off" autoCapitalize="off" spellcheck="false" maxLength="512" aria-label="Search GitHub Docs" aria-describedby="Enter a search term to find it in the GitHub Docs." data-component="input" class="UnstyledTextInput-sc-14ypya-0 jvumlb" value=""/></span></label><button data-component="IconButton" type="submit" data-loading="false" data-no-visuals="true" aria-describedby=":Rucpn6:-loading-announcement" aria-labelledby=":R6cpn6:" class="types__StyledButton-sc-ws60qy-0 jOdgLl"><svg aria-hidden="true" focusable="false" class="octicon octicon-search" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="M10.68 11.74a6 6 0 0 1-7.922-8.982 6 6 0 0 1 8.982 7.922l3.04 3.04a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215ZM11.5 7a4.499 4.499 0 1 0-8.997 0A4.499 4.499 0 0 0 11.5 7Z"></path></svg></button><span data-direction="s" aria-hidden="true" id=":R6cpn6:" class="Tooltip__StyledTooltip-sc-e45c7z-0 eiGLpS">Search</span></form></div></div></div><div class="d-none d-lg-flex flex-items-center"><div data-testid="language-picker" class="d-flex"><button data-component="IconButton" type="button" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" data-no-visuals="true" aria-describedby=":Rkpn6:-loading-announcement" aria-labelledby=":Rukpn6:" id=":Rkpn6:" class="types__StyledButton-sc-ws60qy-0 hmWbvh"><svg aria-hidden="true" focusable="false" class="octicon octicon-globe" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="M8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0ZM5.78 8.75a9.64 9.64 0 0 0 1.363 4.177c.255.426.542.832.857 1.215.245-.296.551-.705.857-1.215A9.64 9.64 0 0 0 10.22 8.75Zm4.44-1.5a9.64 9.64 0 0 0-1.363-4.177c-.307-.51-.612-.919-.857-1.215a9.927 9.927 0 0 0-.857 1.215A9.64 9.64 0 0 0 5.78 7.25Zm-5.944 1.5H1.543a6.507 6.507 0 0 0 4.666 5.5c-.123-.181-.24-.365-.352-.552-.715-1.192-1.437-2.874-1.581-4.948Zm-2.733-1.5h2.733c.144-2.074.866-3.756 1.58-4.948.12-.197.237-.381.353-.552a6.507 6.507 0 0 0-4.666 5.5Zm10.181 1.5c-.144 2.074-.866 3.756-1.58 4.948-.12.197-.237.381-.353.552a6.507 6.507 0 0 0 4.666-5.5Zm2.733-1.5a6.507 6.507 0 0 0-4.666-5.5c.123.181.24.365.353.552.714 1.192 1.436 2.874 1.58 4.948Z"></path></svg></button><span data-direction="s" aria-hidden="true" id=":Rukpn6:" class="Tooltip__StyledTooltip-sc-e45c7z-0 eiGLpS">Select language: current language is English</span></div></div><button data-component="IconButton" type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh hide-lg hide-xl d-flex flex-items-center" data-testid="mobile-search-button" aria-expanded="false" data-loading="false" data-no-visuals="true" aria-describedby=":R74pn6:-loading-announcement" aria-labelledby=":R14pn6:"><svg aria-hidden="true" focusable="false" class="octicon octicon-search" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="M10.68 11.74a6 6 0 0 1-7.922-8.982 6 6 0 0 1 8.982 7.922l3.04 3.04a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215ZM11.5 7a4.499 4.499 0 1 0-8.997 0A4.499 4.499 0 0 0 11.5 7Z"></path></svg></button><span data-direction="s" aria-hidden="true" id=":R14pn6:" class="Tooltip__StyledTooltip-sc-e45c7z-0 eiGLpS">Open Search Bar</span><button data-component="IconButton" type="button" class="types__StyledButton-sc-ws60qy-0 lkeyoI px-3" data-testid="mobile-search-button" aria-expanded="false" data-loading="false" data-no-visuals="true" aria-describedby=":R7cpn6:-loading-announcement" aria-labelledby=":R1cpn6:"><svg aria-hidden="true" focusable="false" class="octicon octicon-x" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="M3.72 3.72a.75.75 0 0 1 1.06 0L8 6.94l3.22-3.22a.749.749 0 0 1 1.275.326.749.749 0 0 1-.215.734L9.06 8l3.22 3.22a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L8 9.06l-3.22 3.22a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042L6.94 8 3.72 4.78a.75.75 0 0 1 0-1.06Z"></path></svg></button><span data-direction="s" aria-hidden="true" id=":R1cpn6:" class="Tooltip__StyledTooltip-sc-e45c7z-0 eiGLpS">Close Search Bar</span><div><button data-component="IconButton" type="button" data-testid="mobile-menu" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" data-no-visuals="true" aria-describedby=":R1kpn6:-loading-announcement" aria-labelledby=":Rvkpn6:" id=":R1kpn6:" class="types__StyledButton-sc-ws60qy-0 htZXvk"><svg aria-hidden="true" focusable="false" class="octicon octicon-kebab-horizontal" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="M8 9a1.5 1.5 0 1 0 0-3 1.5 1.5 0 0 0 0 3ZM1.5 9a1.5 1.5 0 1 0 0-3 1.5 1.5 0 0 0 0 3Zm13 0a1.5 1.5 0 1 0 0-3 1.5 1.5 0 0 0 0 3Z"></path></svg></button><span data-direction="s" aria-hidden="true" id=":Rvkpn6:" class="Tooltip__StyledTooltip-sc-e45c7z-0 eiGLpS">Open Menu</span></div></div></div><div class="d-flex flex-items-center d-xxl-none mt-2" data-testid="header-subnav"><div class="mr-2" data-testid="header-subnav-hamburger"><button data-component="IconButton" type="button" data-testid="sidebar-hamburger" class="types__StyledButton-sc-ws60qy-0 jCopKa color-fg-muted" data-loading="false" data-no-visuals="true" aria-describedby=":R3b9n6:-loading-announcement" aria-labelledby=":Rb9n6:"><svg aria-hidden="true" focusable="false" class="octicon octicon-three-bars" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="M1 2.75A.75.75 0 0 1 1.75 2h12.5a.75.75 0 0 1 0 1.5H1.75A.75.75 0 0 1 1 2.75Zm0 5A.75.75 0 0 1 1.75 7h12.5a.75.75 0 0 1 0 1.5H1.75A.75.75 0 0 1 1 7.75ZM1.75 12h12.5a.75.75 0 0 1 0 1.5H1.75a.75.75 0 0 1 0-1.5Z"></path></svg></button><span data-direction="s" aria-hidden="true" id=":Rb9n6:" class="Tooltip__StyledTooltip-sc-e45c7z-0 eiGLpS">Open Sidebar</span></div><div class="mr-auto width-full" data-search="breadcrumbs"><nav data-testid="breadcrumbs-header" class="f5 breadcrumbs Breadcrumbs_breadcrumbs__xAC4i" aria-label="Breadcrumb" data-container="breadcrumbs"><ul><li class="d-inline-block"><a rel="" data-testid="breadcrumb-link" title="Webhooks" class="Link--primary mr-2 color-fg-muted" href="/en/webhooks">Webhooks</a><span class="color-fg-muted pr-2">/</span></li><li class="d-inline-block"><a rel="" data-testid="breadcrumb-link" title="Webhook events &amp; payloads" class="Link--primary mr-2 color-fg-muted" href="/en/webhooks/webhook-events-and-payloads">Webhook events &amp; payloads</a></li></ul></nav></div></div></header></div><div class="d-lg-flex"><div data-container="nav" class="position-sticky d-none border-right d-xxl-block" style="width:326px;height:calc(100vh - 65px);top:65px"><nav aria-labelledby="allproducts-menu"><div class="d-none px-4 pb-3 border-bottom d-xxl-block"><div class="mt-3"><a rel="" class="f6 pl-2 pr-5 ml-n1 pb-1 Link--primary color-fg-default" href="/en"><svg aria-hidden="true" focusable="false" class="octicon octicon-arrow-left mr-1" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="M7.78 12.53a.75.75 0 0 1-1.06 0L2.47 8.28a.75.75 0 0 1 0-1.06l4.25-4.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042L4.81 7h7.44a.75.75 0 0 1 0 1.5H4.81l2.97 2.97a.75.75 0 0 1 0 1.06Z"></path></svg>Home</a></div><div class="mt-3" id="allproducts-menu"><a rel="" data-testid="sidebar-product-xl" class="d-block pl-1 mb-2 h3 color-fg-default no-underline _product-title" href="/en/webhooks">Webhooks</a></div></div><div class="border-right d-none d-xxl-block bg-primary overflow-y-auto flex-shrink-0" style="width:326px;height:calc(100vh - 175px);padding-bottom:185px"><div data-testid="sidebar" style="overflow-y:auto" class="pt-3"><div class="ml-3" data-testid="product-sidebar"><nav aria-label="Product sidebar" class="NavList__NavBox-sc-1c8ygf7-0"><ul class="List__ListBox-sc-1x7olzq-0 hgjakc"><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a sx="[object Object]" tabindex="0" aria-labelledby=":R3b6n6:--label " id=":R3b6n6:" aria-current="false" class="Link__StyledLink-sc-14289xe-0 cJbOew" href="/en/webhooks/about-webhooks"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R3b6n6:--label" class="Box-sc-g0xbh4-0 bmseMA">About webhooks</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a sx="[object Object]" tabindex="0" aria-labelledby=":R5b6n6:--label " id=":R5b6n6:" aria-current="false" class="Link__StyledLink-sc-14289xe-0 cJbOew" href="/en/webhooks/types-of-webhooks"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R5b6n6:--label" class="Box-sc-g0xbh4-0 bmseMA">Types of webhooks</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 hTSEii"><a sx="[object Object]" tabindex="0" aria-labelledby=":R7b6n6:--label " id=":R7b6n6:" aria-current="page" class="Link__StyledLink-sc-14289xe-0 cJbOew" href="/en/webhooks/webhook-events-and-payloads"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R7b6n6:--label" class="Box-sc-g0xbh4-0 ivpQTm">Webhook events &amp; payloads</span></div></a></li><li aria-labelledby=":R9b6n6:" class="Box-sc-g0xbh4-0 Ywlla"><button tabindex="0" aria-labelledby=":R9b6n6:--label " id=":R9b6n6:" aria-expanded="false" aria-controls=":R9b6n6H1:" class="Item__LiBox-sc-yeql7o-0 itjSOb"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><div class="Box-sc-g0xbh4-0 cUxMoC"><span id=":R9b6n6:--label" class="Box-sc-g0xbh4-0 bmseMA">Using webhooks</span><span class="Box-sc-g0xbh4-0 lmYNOb"><svg sx="[object Object]" aria-hidden="true" focusable="false" class="octicon octicon-chevron-down Octicon-sc-9kayk9-0 daAEFx" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="M12.78 5.22a.749.749 0 0 1 0 1.06l-4.25 4.25a.749.749 0 0 1-1.06 0L3.22 6.28a.749.749 0 1 1 1.06-1.06L8 8.939l3.72-3.719a.749.749 0 0 1 1.06 0Z"></path></svg></span></div></div></button><div><ul id=":R9b6n6H1:" aria-labelledby=":R9b6n6:" class="Box-sc-g0xbh4-0 gMkIpo"><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a sx="[object Object]" tabindex="0" aria-labelledby=":Rqpb6n6:--label " id=":Rqpb6n6:" aria-current="false" class="Link__StyledLink-sc-14289xe-0 fuIgwR" href="/en/webhooks/using-webhooks/creating-webhooks"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":Rqpb6n6:--label" class="Box-sc-g0xbh4-0 bmseMA">Create webhooks</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a sx="[object Object]" tabindex="0" aria-labelledby=":R1apb6n6:--label " id=":R1apb6n6:" aria-current="false" class="Link__StyledLink-sc-14289xe-0 fuIgwR" href="/en/webhooks/using-webhooks/handling-webhook-deliveries"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1apb6n6:--label" class="Box-sc-g0xbh4-0 bmseMA">Handle deliveries</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a sx="[object Object]" tabindex="0" aria-labelledby=":R1qpb6n6:--label " id=":R1qpb6n6:" aria-current="false" class="Link__StyledLink-sc-14289xe-0 fuIgwR" href="/en/webhooks/using-webhooks/validating-webhook-deliveries"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1qpb6n6:--label" class="Box-sc-g0xbh4-0 bmseMA">Validate deliveries</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a sx="[object Object]" tabindex="0" aria-labelledby=":R2apb6n6:--label " id=":R2apb6n6:" aria-current="false" class="Link__StyledLink-sc-14289xe-0 fuIgwR" href="/en/webhooks/using-webhooks/delivering-webhooks-to-private-systems"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R2apb6n6:--label" class="Box-sc-g0xbh4-0 bmseMA">Deliver to private systems</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a sx="[object Object]" tabindex="0" aria-labelledby=":R2qpb6n6:--label " id=":R2qpb6n6:" aria-current="false" class="Link__StyledLink-sc-14289xe-0 fuIgwR" href="/en/webhooks/using-webhooks/editing-webhooks"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R2qpb6n6:--label" class="Box-sc-g0xbh4-0 bmseMA">Edit webhooks</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a sx="[object Object]" tabindex="0" aria-labelledby=":R3apb6n6:--label " id=":R3apb6n6:" aria-current="false" class="Link__StyledLink-sc-14289xe-0 fuIgwR" href="/en/webhooks/using-webhooks/disabling-webhooks"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R3apb6n6:--label" class="Box-sc-g0xbh4-0 bmseMA">Disable webhooks</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a sx="[object Object]" tabindex="0" aria-labelledby=":R3qpb6n6:--label " id=":R3qpb6n6:" aria-current="false" class="Link__StyledLink-sc-14289xe-0 fuIgwR" href="/en/webhooks/using-webhooks/best-practices-for-using-webhooks"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R3qpb6n6:--label" class="Box-sc-g0xbh4-0 bmseMA">Best practices</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a sx="[object Object]" tabindex="0" aria-labelledby=":R4apb6n6:--label " id=":R4apb6n6:" aria-current="false" class="Link__StyledLink-sc-14289xe-0 fuIgwR" href="/en/webhooks/using-webhooks/handling-failed-webhook-deliveries"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R4apb6n6:--label" class="Box-sc-g0xbh4-0 bmseMA">Handle failed deliveries</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a sx="[object Object]" tabindex="0" aria-labelledby=":R4qpb6n6:--label " id=":R4qpb6n6:" aria-current="false" class="Link__StyledLink-sc-14289xe-0 fuIgwR" href="/en/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-repository-webhook"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R4qpb6n6:--label" class="Box-sc-g0xbh4-0 bmseMA">Automatically redeliver for repository</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a sx="[object Object]" tabindex="0" aria-labelledby=":R5apb6n6:--label " id=":R5apb6n6:" aria-current="false" class="Link__StyledLink-sc-14289xe-0 fuIgwR" href="/en/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-an-organization-webhook"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R5apb6n6:--label" class="Box-sc-g0xbh4-0 bmseMA">Automatically redeliver for organization</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a sx="[object Object]" tabindex="0" aria-labelledby=":R5qpb6n6:--label " id=":R5qpb6n6:" aria-current="false" class="Link__StyledLink-sc-14289xe-0 fuIgwR" href="/en/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-github-app-webhook"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R5qpb6n6:--label" class="Box-sc-g0xbh4-0 bmseMA">Automatically redeliver for GitHub App</span></div></a></li></ul></div></li><li aria-labelledby=":Rbb6n6:" class="Box-sc-g0xbh4-0 Ywlla"><button tabindex="0" aria-labelledby=":Rbb6n6:--label " id=":Rbb6n6:" aria-expanded="false" aria-controls=":Rbb6n6H1:" class="Item__LiBox-sc-yeql7o-0 itjSOb"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><div class="Box-sc-g0xbh4-0 cUxMoC"><span id=":Rbb6n6:--label" class="Box-sc-g0xbh4-0 bmseMA">Testing and troubleshooting webhooks</span><span class="Box-sc-g0xbh4-0 lmYNOb"><svg sx="[object Object]" aria-hidden="true" focusable="false" class="octicon octicon-chevron-down Octicon-sc-9kayk9-0 daAEFx" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="M12.78 5.22a.749.749 0 0 1 0 1.06l-4.25 4.25a.749.749 0 0 1-1.06 0L3.22 6.28a.749.749 0 1 1 1.06-1.06L8 8.939l3.72-3.719a.749.749 0 0 1 1.06 0Z"></path></svg></span></div></div></button><div><ul id=":Rbb6n6H1:" aria-labelledby=":Rbb6n6:" class="Box-sc-g0xbh4-0 gMkIpo"><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a sx="[object Object]" tabindex="0" aria-labelledby=":Rqrb6n6:--label " id=":Rqrb6n6:" aria-current="false" class="Link__StyledLink-sc-14289xe-0 fuIgwR" href="/en/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":Rqrb6n6:--label" class="Box-sc-g0xbh4-0 bmseMA">View deliveries</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a sx="[object Object]" tabindex="0" aria-labelledby=":R1arb6n6:--label " id=":R1arb6n6:" aria-current="false" class="Link__StyledLink-sc-14289xe-0 fuIgwR" href="/en/webhooks/testing-and-troubleshooting-webhooks/redelivering-webhooks"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1arb6n6:--label" class="Box-sc-g0xbh4-0 bmseMA">Redeliver webhooks</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a sx="[object Object]" tabindex="0" aria-labelledby=":R1qrb6n6:--label " id=":R1qrb6n6:" aria-current="false" class="Link__StyledLink-sc-14289xe-0 fuIgwR" href="/en/webhooks/testing-and-troubleshooting-webhooks/testing-webhooks"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1qrb6n6:--label" class="Box-sc-g0xbh4-0 bmseMA">Test webhooks</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a sx="[object Object]" tabindex="0" aria-labelledby=":R2arb6n6:--label " id=":R2arb6n6:" aria-current="false" class="Link__StyledLink-sc-14289xe-0 fuIgwR" href="/en/webhooks/testing-and-troubleshooting-webhooks/troubleshooting-webhooks"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R2arb6n6:--label" class="Box-sc-g0xbh4-0 bmseMA">Troubleshoot webhooks</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a sx="[object Object]" tabindex="0" aria-labelledby=":R2qrb6n6:--label " id=":R2qrb6n6:" aria-current="false" class="Link__StyledLink-sc-14289xe-0 fuIgwR" href="/en/webhooks/testing-and-troubleshooting-webhooks/using-the-github-cli-to-forward-webhooks-for-testing"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R2qrb6n6:--label" class="Box-sc-g0xbh4-0 bmseMA">Test with the CLI</span></div></a></li></ul></div></li></ul></nav></div></div></div></nav></div><div class="flex-column flex-1 min-width-0"><main id="main-content" style="scroll-margin-top:5rem"><div class="container-xl px-3 px-md-6 my-4"><div class="ArticleGridLayout_containerBox__lLLio"><div class="Box-sc-g0xbh4-0 eQiQea"><div class="d-none d-xl-block my-3 mr-auto width-full"><nav data-testid="breadcrumbs-in-article" class="f5 breadcrumbs Breadcrumbs_breadcrumbs__xAC4i" aria-label="Breadcrumb" data-container="breadcrumbs"><ul><li class="d-inline-block"><a rel="" data-testid="breadcrumb-link" title="Webhooks" class="Link--primary mr-2 color-fg-muted" href="/en/webhooks">Webhooks</a><span class="color-fg-muted pr-2">/</span></li><li class="d-inline-block"><a rel="" data-testid="breadcrumb-link" title="Webhook events &amp; payloads" class="Link--primary mr-2 color-fg-muted d-none" href="/en/webhooks/webhook-events-and-payloads">Webhook events &amp; payloads</a></li></ul></nav></div><div class="d-flex flex-items-baseline flex-justify-between" data-container="title"><h1 id="title-h1" class="border-bottom-0">Webhook events and payloads</h1></div></div><div id="article-intro" class="Box-sc-g0xbh4-0 ijSsTo f4 pb-4"><div class="f2 color-fg-muted mb-3 Lead_container__m3L5f" data-container="lead" data-testid="lead" data-search="lead"><p>Learn about when each webhook event occurs and what the payload contains.</p></div></div><div data-container="toc" class="Box-sc-g0xbh4-0 giVcWX ArticleGridLayout_sidebarBox__Cj_03 border-bottom border-lg-0 pb-4 mb-5 pb-xl-0 mb-xl-0"><h2 id="in-this-article" class="Heading__StyledHeading-sc-1c1dgg0-0 bebFBv mb-1 ml-3" aria-label="In this article">In this article</h2><nav data-testid="minitoc" class="NavList__NavBox-sc-1c8ygf7-0 Minitocs_miniToc__NaGol my-2" aria-labelledby="in-this-article"><ul class="List__ListBox-sc-1x7olzq-0 hgjakc"><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R10djmqn6:--label " id=":R10djmqn6:" aria-current="false" href="#about-webhook-events-and-payloads" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R10djmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">About webhook events and payloads</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R10ljmqn6:--label " id=":R10ljmqn6:" aria-current="false" href="#branch_protection_configuration" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R10ljmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">branch_protection_configuration</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R10tjmqn6:--label " id=":R10tjmqn6:" aria-current="false" href="#branch_protection_rule" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R10tjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">branch_protection_rule</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R115jmqn6:--label " id=":R115jmqn6:" aria-current="false" href="#check_run" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R115jmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">check_run</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R11djmqn6:--label " id=":R11djmqn6:" aria-current="false" href="#check_suite" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R11djmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">check_suite</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R11ljmqn6:--label " id=":R11ljmqn6:" aria-current="false" href="#code_scanning_alert" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R11ljmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">code_scanning_alert</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R11tjmqn6:--label " id=":R11tjmqn6:" aria-current="false" href="#commit_comment" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R11tjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">commit_comment</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R125jmqn6:--label " id=":R125jmqn6:" aria-current="false" href="#create" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R125jmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">create</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R12djmqn6:--label " id=":R12djmqn6:" aria-current="false" href="#custom_property" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R12djmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">custom_property</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R12ljmqn6:--label " id=":R12ljmqn6:" aria-current="false" href="#custom_property_values" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R12ljmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">custom_property_values</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R12tjmqn6:--label " id=":R12tjmqn6:" aria-current="false" href="#delete" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R12tjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">delete</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R135jmqn6:--label " id=":R135jmqn6:" aria-current="false" href="#dependabot_alert" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R135jmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">dependabot_alert</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R13djmqn6:--label " id=":R13djmqn6:" aria-current="false" href="#deploy_key" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R13djmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">deploy_key</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R13ljmqn6:--label " id=":R13ljmqn6:" aria-current="false" href="#deployment" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R13ljmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">deployment</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R13tjmqn6:--label " id=":R13tjmqn6:" aria-current="false" href="#deployment_protection_rule" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R13tjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">deployment_protection_rule</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R145jmqn6:--label " id=":R145jmqn6:" aria-current="false" href="#deployment_review" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R145jmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">deployment_review</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R14djmqn6:--label " id=":R14djmqn6:" aria-current="false" href="#deployment_status" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R14djmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">deployment_status</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R14ljmqn6:--label " id=":R14ljmqn6:" aria-current="false" href="#discussion" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R14ljmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">discussion</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R14tjmqn6:--label " id=":R14tjmqn6:" aria-current="false" href="#discussion_comment" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R14tjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">discussion_comment</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R155jmqn6:--label " id=":R155jmqn6:" aria-current="false" href="#fork" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R155jmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">fork</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R15djmqn6:--label " id=":R15djmqn6:" aria-current="false" href="#github_app_authorization" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R15djmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">github_app_authorization</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R15ljmqn6:--label " id=":R15ljmqn6:" aria-current="false" href="#gollum" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R15ljmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">gollum</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R15tjmqn6:--label " id=":R15tjmqn6:" aria-current="false" href="#installation" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R15tjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">installation</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R165jmqn6:--label " id=":R165jmqn6:" aria-current="false" href="#installation_repositories" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R165jmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">installation_repositories</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R16djmqn6:--label " id=":R16djmqn6:" aria-current="false" href="#installation_target" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R16djmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">installation_target</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R16ljmqn6:--label " id=":R16ljmqn6:" aria-current="false" href="#issue_comment" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R16ljmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">issue_comment</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R16tjmqn6:--label " id=":R16tjmqn6:" aria-current="false" href="#issues" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R16tjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">issues</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R175jmqn6:--label " id=":R175jmqn6:" aria-current="false" href="#label" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R175jmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">label</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R17djmqn6:--label " id=":R17djmqn6:" aria-current="false" href="#marketplace_purchase" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R17djmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">marketplace_purchase</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R17ljmqn6:--label " id=":R17ljmqn6:" aria-current="false" href="#member" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R17ljmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">member</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R17tjmqn6:--label " id=":R17tjmqn6:" aria-current="false" href="#membership" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R17tjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">membership</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R185jmqn6:--label " id=":R185jmqn6:" aria-current="false" href="#merge_group" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R185jmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">merge_group</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R18djmqn6:--label " id=":R18djmqn6:" aria-current="false" href="#meta" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R18djmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">meta</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R18ljmqn6:--label " id=":R18ljmqn6:" aria-current="false" href="#milestone" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R18ljmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">milestone</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R18tjmqn6:--label " id=":R18tjmqn6:" aria-current="false" href="#org_block" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R18tjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">org_block</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R195jmqn6:--label " id=":R195jmqn6:" aria-current="false" href="#organization" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R195jmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">organization</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R19djmqn6:--label " id=":R19djmqn6:" aria-current="false" href="#package" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R19djmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">package</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R19ljmqn6:--label " id=":R19ljmqn6:" aria-current="false" href="#page_build" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R19ljmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">page_build</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R19tjmqn6:--label " id=":R19tjmqn6:" aria-current="false" href="#personal_access_token_request" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R19tjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">personal_access_token_request</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1a5jmqn6:--label " id=":R1a5jmqn6:" aria-current="false" href="#ping" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1a5jmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">ping</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1adjmqn6:--label " id=":R1adjmqn6:" aria-current="false" href="#project_card" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1adjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">project_card</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1aljmqn6:--label " id=":R1aljmqn6:" aria-current="false" href="#project" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1aljmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">project</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1atjmqn6:--label " id=":R1atjmqn6:" aria-current="false" href="#project_column" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1atjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">project_column</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1b5jmqn6:--label " id=":R1b5jmqn6:" aria-current="false" href="#projects_v2" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1b5jmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">projects_v2</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1bdjmqn6:--label " id=":R1bdjmqn6:" aria-current="false" href="#projects_v2_item" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1bdjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">projects_v2_item</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1bljmqn6:--label " id=":R1bljmqn6:" aria-current="false" href="#projects_v2_status_update" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1bljmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">projects_v2_status_update</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1btjmqn6:--label " id=":R1btjmqn6:" aria-current="false" href="#public" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1btjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">public</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1c5jmqn6:--label " id=":R1c5jmqn6:" aria-current="false" href="#pull_request" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1c5jmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">pull_request</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1cdjmqn6:--label " id=":R1cdjmqn6:" aria-current="false" href="#pull_request_review_comment" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1cdjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">pull_request_review_comment</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1cljmqn6:--label " id=":R1cljmqn6:" aria-current="false" href="#pull_request_review" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1cljmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">pull_request_review</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1ctjmqn6:--label " id=":R1ctjmqn6:" aria-current="false" href="#pull_request_review_thread" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1ctjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">pull_request_review_thread</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1d5jmqn6:--label " id=":R1d5jmqn6:" aria-current="false" href="#push" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1d5jmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">push</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1ddjmqn6:--label " id=":R1ddjmqn6:" aria-current="false" href="#registry_package" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1ddjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">registry_package</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1dljmqn6:--label " id=":R1dljmqn6:" aria-current="false" href="#release" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1dljmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">release</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1dtjmqn6:--label " id=":R1dtjmqn6:" aria-current="false" href="#repository_advisory" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1dtjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">repository_advisory</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1e5jmqn6:--label " id=":R1e5jmqn6:" aria-current="false" href="#repository" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1e5jmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">repository</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1edjmqn6:--label " id=":R1edjmqn6:" aria-current="false" href="#repository_dispatch" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1edjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">repository_dispatch</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1eljmqn6:--label " id=":R1eljmqn6:" aria-current="false" href="#repository_import" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1eljmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">repository_import</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1etjmqn6:--label " id=":R1etjmqn6:" aria-current="false" href="#repository_ruleset" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1etjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">repository_ruleset</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1f5jmqn6:--label " id=":R1f5jmqn6:" aria-current="false" href="#repository_vulnerability_alert" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1f5jmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">repository_vulnerability_alert</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1fdjmqn6:--label " id=":R1fdjmqn6:" aria-current="false" href="#secret_scanning_alert" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1fdjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">secret_scanning_alert</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1fljmqn6:--label " id=":R1fljmqn6:" aria-current="false" href="#secret_scanning_alert_location" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1fljmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">secret_scanning_alert_location</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1ftjmqn6:--label " id=":R1ftjmqn6:" aria-current="false" href="#secret_scanning_scan" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1ftjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">secret_scanning_scan</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1g5jmqn6:--label " id=":R1g5jmqn6:" aria-current="false" href="#security_advisory" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1g5jmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">security_advisory</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1gdjmqn6:--label " id=":R1gdjmqn6:" aria-current="false" href="#security_and_analysis" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1gdjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">security_and_analysis</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1gljmqn6:--label " id=":R1gljmqn6:" aria-current="false" href="#sponsorship" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1gljmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">sponsorship</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1gtjmqn6:--label " id=":R1gtjmqn6:" aria-current="false" href="#star" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1gtjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">star</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1h5jmqn6:--label " id=":R1h5jmqn6:" aria-current="false" href="#status" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1h5jmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">status</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1hdjmqn6:--label " id=":R1hdjmqn6:" aria-current="false" href="#sub_issues" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1hdjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">sub_issues</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1hljmqn6:--label " id=":R1hljmqn6:" aria-current="false" href="#team_add" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1hljmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">team_add</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1htjmqn6:--label " id=":R1htjmqn6:" aria-current="false" href="#team" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1htjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">team</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1i5jmqn6:--label " id=":R1i5jmqn6:" aria-current="false" href="#watch" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1i5jmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">watch</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1idjmqn6:--label " id=":R1idjmqn6:" aria-current="false" href="#workflow_dispatch" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1idjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">workflow_dispatch</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1iljmqn6:--label " id=":R1iljmqn6:" aria-current="false" href="#workflow_job" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1iljmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">workflow_job</span></div></a></li><li class="Item__LiBox-sc-yeql7o-0 lnYQME"><a tabindex="0" aria-labelledby=":R1itjmqn6:--label " id=":R1itjmqn6:" aria-current="false" href="#workflow_run" class="Link__StyledLink-sc-14289xe-0 cJbOew Minitocs_nested__JSAov"><div data-component="ActionList.Item--DividerContainer" class="Box-sc-g0xbh4-0 hROlum"><span id=":R1itjmqn6:--label" class="Box-sc-g0xbh4-0 bmseMA">workflow_run</span></div></a></li></ul></nav></div><div data-container="article" data-search="article-body" class="Box-sc-g0xbh4-0 kohLxz"><div id="article-contents"><div class="MarkdownContent_markdownBody__v5MYy markdown-body pt-3 pb-4"><h2 id="about-webhook-events-and-payloads" tabindex="-1"><a class="heading-link" href="#about-webhook-events-and-payloads">About webhook events and payloads<span class="heading-link-symbol" aria-hidden="true"></span></a></h2> <p>You can create webhooks that subscribe to the events listed on this page. To limit the number of HTTP requests to your server, you should only subscribe to the specific events that you plan on handling. For more information, see <a href="/en/webhooks/creating-webhooks" _originalHref="/webhooks/creating-webhooks">Creating webhooks</a>.</p> <p>Each webhook event on this page includes a description of the webhook properties for that event. If the event has multiple actions, the properties corresponding to each action are included.</p> <p>Each event is only available to specific types of webhooks. For example, an organization webhook can subscribe to the <code>team</code> event, but a repository webhook cannot. The description of each webhook event lists the availability for that event. For more information, see <a href="/en/webhooks/types-of-webhooks" _originalHref="/webhooks/types-of-webhooks">Types of webhooks</a>.</p> <h3 id="payload-cap" tabindex="-1"><a class="heading-link" href="#payload-cap">Payload cap<span class="heading-link-symbol" aria-hidden="true"></span></a></h3> <p>Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, on a <code>create</code> event if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.</p> <h3 id="delivery-headers" tabindex="-1"><a class="heading-link" href="#delivery-headers">Delivery headers<span class="heading-link-symbol" aria-hidden="true"></span></a></h3> <p>HTTP POST payloads that are delivered to your webhook's configured URL endpoint will contain several special headers:</p> <ul> <li><code>X-GitHub-Hook-ID</code>: The unique identifier of the webhook.</li> <li><code>X-GitHub-Event</code>: The name of the event that triggered the delivery.</li> <li><code>X-GitHub-Delivery</code>: A globally unique identifier (GUID) to identify the event.</li> <li><code>X-Hub-Signature</code>: This header is sent if the webhook is configured with a <code>secret</code>. This is the HMAC hex digest of the request body, and is generated using the SHA-1 hash function and the <code>secret</code> as the HMAC <code>key</code>. <code>X-Hub-Signature</code> is provided for compatibility with existing integrations. We recommend that you use the more secure <code>X-Hub-Signature-256</code> instead.</li> <li><code>X-Hub-Signature-256</code>: This header is sent if the webhook is configured with a <code>secret</code>. This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and the <code>secret</code> as the HMAC <code>key</code>. For more information, see <a href="/en/webhooks/using-webhooks/securing-your-webhooks" _originalHref="/webhooks/using-webhooks/securing-your-webhooks">Validating webhook deliveries</a>.</li> <li><code>User-Agent</code>: This header will always have the prefix <code>GitHub-Hookshot/</code>.</li> <li><code>X-GitHub-Hook-Installation-Target-Type</code>: The type of resource where the webhook was created.</li> <li><code>X-GitHub-Hook-Installation-Target-ID</code>: The unique identifier of the resource where the webhook was created.</li> </ul> <p>To see what each header might look like in a webhook payload, see <a href="#example-webhook-delivery">Example webhook delivery</a>.</p> <h3 id="example-webhook-delivery" tabindex="-1"><a class="heading-link" href="#example-webhook-delivery">Example webhook delivery<span class="heading-link-symbol" aria-hidden="true"></span></a></h3> <p>You can choose to have payloads delivered in JSON format (<code>application/json</code>) or as URL-encoded data (<code>x-www-form-urlencoded</code>). Following is an example of a webhook POST request that uses the JSON format.</p> <pre><code class="hljs language-shell"><span class="hljs-meta prompt_">> </span><span class="bash">POST /payload HTTP/1.1</span> <span class="hljs-meta prompt_"> > </span><span class="bash">X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958</span> <span class="hljs-meta prompt_">> </span><span class="bash">X-Hub-Signature: sha1=7d38cdd689735b008b3c702edd92eea23791c5f6</span> <span class="hljs-meta prompt_">> </span><span class="bash">X-Hub-Signature-256: sha256=d57c68ca6f92289e6987922ff26938930f6e66a2d161ef06abdf1859230aa23c</span> <span class="hljs-meta prompt_">> </span><span class="bash">User-Agent: GitHub-Hookshot/044aadd</span> <span class="hljs-meta prompt_">> </span><span class="bash">Content-Type: application/json</span> <span class="hljs-meta prompt_">> </span><span class="bash">Content-Length: 6615</span> <span class="hljs-meta prompt_">> </span><span class="bash">X-GitHub-Event: issues</span> <span class="hljs-meta prompt_">> </span><span class="bash">X-GitHub-Hook-ID: 292430182</span> <span class="hljs-meta prompt_">> </span><span class="bash">X-GitHub-Hook-Installation-Target-ID: 79929171</span> <span class="hljs-meta prompt_">> </span><span class="bash">X-GitHub-Hook-Installation-Target-Type: repository</span> <span class="hljs-meta prompt_"> > </span><span class="bash">{</span> <span class="hljs-meta prompt_">> </span><span class="bash"> <span class="hljs-string">"action"</span>: <span class="hljs-string">"opened"</span>,</span> <span class="hljs-meta prompt_">> </span><span class="bash"> <span class="hljs-string">"issue"</span>: {</span> <span class="hljs-meta prompt_">> </span><span class="bash"> <span class="hljs-string">"url"</span>: <span class="hljs-string">"https://api.github.com/repos/octocat/Hello-World/issues/1347"</span>,</span> <span class="hljs-meta prompt_">> </span><span class="bash"> <span class="hljs-string">"number"</span>: 1347,</span> <span class="hljs-meta prompt_">> </span><span class="bash"> ...</span> <span class="hljs-meta prompt_">> </span><span class="bash"> },</span> <span class="hljs-meta prompt_">> </span><span class="bash"> <span class="hljs-string">"repository"</span> : {</span> <span class="hljs-meta prompt_">> </span><span class="bash"> <span class="hljs-string">"id"</span>: 1296269,</span> <span class="hljs-meta prompt_">> </span><span class="bash"> <span class="hljs-string">"full_name"</span>: <span class="hljs-string">"octocat/Hello-World"</span>,</span> <span class="hljs-meta prompt_">> </span><span class="bash"> <span class="hljs-string">"owner"</span>: {</span> <span class="hljs-meta prompt_">> </span><span class="bash"> <span class="hljs-string">"login"</span>: <span class="hljs-string">"octocat"</span>,</span> <span class="hljs-meta prompt_">> </span><span class="bash"> <span class="hljs-string">"id"</span>: 1,</span> <span class="hljs-meta prompt_">> </span><span class="bash"> ...</span> <span class="hljs-meta prompt_">> </span><span class="bash"> },</span> <span class="hljs-meta prompt_">> </span><span class="bash"> ...</span> <span class="hljs-meta prompt_">> </span><span class="bash"> },</span> <span class="hljs-meta prompt_">> </span><span class="bash"> <span class="hljs-string">"sender"</span>: {</span> <span class="hljs-meta prompt_">> </span><span class="bash"> <span class="hljs-string">"login"</span>: <span class="hljs-string">"octocat"</span>,</span> <span class="hljs-meta prompt_">> </span><span class="bash"> <span class="hljs-string">"id"</span>: 1,</span> <span class="hljs-meta prompt_">> </span><span class="bash"> ...</span> <span class="hljs-meta prompt_">> </span><span class="bash"> }</span> <span class="hljs-meta prompt_">> </span><span class="bash">}</span> </code></pre></div><div class="MarkdownContent_markdownBody__v5MYy markdown-body pt-3 pb-4"><div><div><h2 id="branch_protection_configuration" tabindex="-1"><a class="heading-link" href="#branch_protection_configuration">branch_protection_configuration<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is a change to branch protection configurations for a repository. For more information, see "<a href="https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches">About protected branches</a>." For information about using the APIs to manage branch protection rules, see "<a href="https://docs.github.com/graphql/reference/objects#branchprotectionrule">Branch protection rule</a>" in the GraphQL documentation or "<a href="https://docs.github.com/rest/branches/branch-protection">Branch protection</a>" in the REST API documentation.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.</p></div><h3>Availability for <code>branch_protection_configuration</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>branch_protection_configuration</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd06kmqn6:-loading-announcement" id=":Rd06kmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">disabled</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>All branch protections were disabled for a repository.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>disabled</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="branch_protection_rule" tabindex="-1"><a class="heading-link" href="#branch_protection_rule">branch_protection_rule<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to branch protection rules. For more information, see "<a href="https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches">About protected branches</a>." For information about the APIs to manage branch protection rules, see <a href="https://docs.github.com/graphql/reference/objects#branchprotectionrule">the GraphQL documentation</a> or "<a href="https://docs.github.com/rest/branches/branch-protection">Branch protection</a>" in the REST API documentation.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.</p></div><h3>Availability for <code>branch_protection_rule</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>branch_protection_rule</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd0akmqn6:-loading-announcement" id=":Rd0akmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">created</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A branch protection rule was created.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>created</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">rule</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The branch protection rule. Includes a <code>name</code> and all the <a href="https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings">branch protection settings</a> applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of <code>off</code>, <code>non_admins</code>, or <code>everyone</code>. Actor and build lists are arrays of strings.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="rule" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="branch_protection_rule--rule">Properties of <code>rule</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="check_run" tabindex="-1"><a class="heading-link" href="#check_run">check_run<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a check run. For information about check runs, see "<a href="https://docs.github.com/rest/guides/getting-started-with-the-checks-api">Getting started with the Checks API</a>." For information about the APIs to manage check runs, see <a href="https://docs.github.com/graphql/reference/objects#checkrun">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/checks/runs">Check Runs</a>" in the REST API documentation.</p> <p>For activity relating to check suites, use the <code>check-suite</code> event.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the <code>rerequested</code> and <code>requested_action</code> event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.</p> <p>Repository and organization webhooks only receive payloads for the <code>created</code> and <code>completed</code> event types in repositories.</p> <div class="ghd-alert ghd-alert-accent"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg>Note</p> <p> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p> </div></div><h3>Availability for <code>check_run</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>check_run</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd0ekmqn6:-loading-announcement" id=":Rd0ekmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">completed</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A check run was completed, and a conclusion is available.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> </div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>completed</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">check_run</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A check performed on the code of a given code change</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="check_run" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="check_run--check_run">Properties of <code>check_run</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="check_suite" tabindex="-1"><a class="heading-link" href="#check_suite">check_suite<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a check suite. For information about check suites, see "<a href="https://docs.github.com/rest/guides/getting-started-with-the-checks-api">Getting started with the Checks API</a>." For information about the APIs to manage check suites, see <a href="https://docs.github.com/graphql/reference/objects#checksuite">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/checks/suites">Check Suites</a>" in the REST API documentation.</p> <p>For activity relating to check runs, use the <code>check_run</code> event.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the <code>requested</code> and <code>rerequested</code> event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.</p> <p>Repository and organization webhooks only receive payloads for the <code>completed</code> event types in repositories.</p> <div class="ghd-alert ghd-alert-accent"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg>Note</p> <p> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p> </div></div><h3>Availability for <code>check_suite</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>check_suite</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd0ikmqn6:-loading-announcement" id=":Rd0ikmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">completed</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>All check runs in a check suite have completed, and a conclusion is available.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>completed</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">check_suite</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The <a href="https://docs.github.com/rest/checks/suites#get-a-check-suite">check_suite</a>.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="check_suite" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="check_suite--check_suite">Properties of <code>check_suite</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="code_scanning_alert" tabindex="-1"><a class="heading-link" href="#code_scanning_alert">code_scanning_alert<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "<a href="https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning">About code scanning</a>" and "<a href="https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts">About code scanning alerts</a>." For information about the API to manage code scanning, see "<a href="https://docs.github.com/rest/code-scanning">Code scanning</a>" in the REST API documentation.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission.</p></div><h3>Availability for <code>code_scanning_alert</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>code_scanning_alert</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd0mkmqn6:-loading-announcement" id=":Rd0mkmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">appeared_in_branch</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>appeared_in_branch</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">alert</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The code scanning alert involved in the event.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="alert" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="code_scanning_alert--alert">Properties of <code>alert</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">commit_oid</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The commit SHA of the code scanning alert. When the action is <code>reopened_by_user</code> or <code>closed_by_user</code>, the event was triggered by the <code>sender</code> and this value will be empty.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">ref</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The Git reference of the code scanning alert. When the action is <code>reopened_by_user</code> or <code>closed_by_user</code>, the event was triggered by the <code>sender</code> and this value will be empty.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="commit_comment" tabindex="-1"><a class="heading-link" href="#commit_comment">commit_comment<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to commit comments. For more information about commit comments, see "<a href="https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request">Commenting on a pull request</a>." For information about the APIs to manage commit comments, see <a href="https://docs.github.com/graphql/reference/objects#commitcomment">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/commits/comments">Commit comments</a>" in the REST API documentation.</p> <p>For activity relating to comments on pull request reviews, use the <code>pull_request_review_comment</code> event. For activity relating to issue comments, use the <code>issue_comment</code> event. For activity relating to discussion comments, use the <code>discussion_comment</code> event.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.</p></div><h3>Availability for <code>commit_comment</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>commit_comment</code></h3><div class="mb-4 f5 color-fg-muted"><p>Someone commented on a commit.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The action performed. Can be <code>created</code>.</p></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>created</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">comment</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The <a href="$%7BexternalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl%7D/rest/commits/comments#get-a-commit-comment">commit comment</a> resource.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="comment" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="commit_comment--comment">Properties of <code>comment</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="create" tabindex="-1"><a class="heading-link" href="#create">create<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when a Git branch or tag is created.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.</p> <p><strong>Notes</strong>:</p> <ul> <li>This event will not occur when more than three tags are created at once.</li> <li>Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.</li> </ul></div><h3>Availability for <code>create</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>create</code></h3><div class="mb-4 f5 color-fg-muted"></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">description</code> <span class="color-fg-muted pl-2 f5">string or null</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository's current description.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">master_branch</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The name of the repository's default branch (usually <code>main</code>).</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">pusher_type</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The pusher type for the event. Can be either <code>user</code> or a deploy key.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">ref</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The <a href="https://docs.github.com/rest/git/refs#get-a-reference"><code>git ref</code></a> resource.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">ref_type</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The type of Git ref object created in the repository.</p></div><div class="pt-2"><p><span>Can be one of<!-- -->:<!-- --> </span><span><code>tag</code>,<!-- --> </span><span><code>branch</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="custom_property" tabindex="-1"><a class="heading-link" href="#custom_property">custom_property<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a custom property.</p> <p>For more information, see "<a href="https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization">Managing custom properties for repositories in your organization</a>". For information about the APIs to manage custom properties, see "<a href="https://docs.github.com/rest/orgs/custom-properties">Custom properties</a>" in the REST API documentation.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission.</p></div><h3>Availability for <code>custom_property</code></h3><ul><li>Enterprises</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>custom_property</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd12kmqn6:-loading-announcement" id=":Rd12kmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">created</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A new custom property was created.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>created</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">definition</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>Custom property defined on an organization</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="definition" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="custom_property--definition">Properties of <code>definition</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="custom_property_values" tabindex="-1"><a class="heading-link" href="#custom_property_values">custom_property_values<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to custom property values for a repository.</p> <p>For more information, see "<a href="https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization">Managing custom properties for repositories in your organization</a>". For information about the APIs to manage custom properties for a repository, see "<a href="https://docs.github.com/rest/repos/custom-properties">Custom properties</a>" in the REST API documentation.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission.</p></div><h3>Availability for <code>custom_property_values</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>custom_property_values</code></h3><div class="mb-4 f5 color-fg-muted"><p>The custom property values of a repository were updated.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>updated</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">new_property_values</code> <span class="color-fg-muted pl-2 f5">array of objects</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The new custom property values for the repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="new_property_values" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="custom_property_values--new_property_values">Properties of <code>new_property_values</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">old_property_values</code> <span class="color-fg-muted pl-2 f5">array of objects</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The old custom property values for the repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="old_property_values" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="custom_property_values--old_property_values">Properties of <code>old_property_values</code></span></summary></details></td></tr></tbody></table></div></div></div></div><div><div><h2 id="delete" tabindex="-1"><a class="heading-link" href="#delete">delete<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including branch and tag deletions, use the <a href="#push"><code>push</code></a> webhook event.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.</p> <div class="ghd-alert ghd-alert-accent"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg>Note</p> <p> This event will not occur when more than three tags are deleted at once.</p> </div></div><h3>Availability for <code>delete</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>delete</code></h3><div class="mb-4 f5 color-fg-muted"></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">pusher_type</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The pusher type for the event. Can be either <code>user</code> or a deploy key.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">ref</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The <a href="https://docs.github.com/rest/git/refs#get-a-reference"><code>git ref</code></a> resource.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">ref_type</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The type of Git ref object deleted in the repository.</p></div><div class="pt-2"><p><span>Can be one of<!-- -->:<!-- --> </span><span><code>tag</code>,<!-- --> </span><span><code>branch</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="dependabot_alert" tabindex="-1"><a class="heading-link" href="#dependabot_alert">dependabot_alert<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to Dependabot alerts.</p> <p>For more information about Dependabot alerts, see "<a href="https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts">About Dependabot alerts</a>." For information about the API to manage Dependabot alerts, see "<a href="https://docs.github.com/rest/dependabot/alerts">Dependabot alerts</a>" in the REST API documentation.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission.</p> <div class="ghd-alert ghd-alert-accent"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg>Note</p> <p> Webhook events for Dependabot alerts are currently in public preview and subject to change.</p> </div></div><h3>Availability for <code>dependabot_alert</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>dependabot_alert</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd1ekmqn6:-loading-announcement" id=":Rd1ekmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">auto_dismissed</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A Dependabot alert was automatically closed by a Dependabot auto-triage rule.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>auto_dismissed</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">alert</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A Dependabot alert.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="alert" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="dependabot_alert--alert">Properties of <code>alert</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="deploy_key" tabindex="-1"><a class="heading-link" href="#deploy_key">deploy_key<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to deploy keys. For more information, see "<a href="https://docs.github.com/developers/overview/managing-deploy-keys">Managing deploy keys</a>." For information about the APIs to manage deploy keys, see <a href="https://docs.github.com/graphql/reference/objects#deploykey">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/deploy-keys">Deploy keys</a>" in the REST API documentation.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.</p></div><h3>Availability for <code>deploy_key</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>deploy_key</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd1ikmqn6:-loading-announcement" id=":Rd1ikmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">created</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A deploy key was created.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>created</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">key</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The <a href="https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key"><code>deploy key</code></a> resource.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="key" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="deploy_key--key">Properties of <code>key</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="deployment" tabindex="-1"><a class="heading-link" href="#deployment">deployment<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to deployments. For more information, see "<a href="https://docs.github.com/actions/deployment/about-deployments">About deployments</a>." For information about the APIs to manage deployments, see <a href="https://docs.github.com/graphql/reference/objects#deployment">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/deployments/deployments">Deployments</a>" in the REST API documentation.</p> <p>For activity relating to deployment status, use the <code>deployment_status</code> event.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.</p></div><h3>Availability for <code>deployment</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>deployment</code></h3><div class="mb-4 f5 color-fg-muted"><p>A deployment was created.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>created</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">deployment</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The <a href="https://docs.github.com/rest/deployments/deployments#list-deployments">deployment</a>.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="deployment" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="deployment--deployment">Properties of <code>deployment</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">workflow</code> <span class="color-fg-muted pl-2 f5">object or null</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="workflow" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="deployment--workflow">Properties of <code>workflow</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">workflow_run</code> <span class="color-fg-muted pl-2 f5">object or null</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="workflow_run" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="deployment--workflow_run">Properties of <code>workflow_run</code></span></summary></details></td></tr></tbody></table></div></div></div></div><div><div><h2 id="deployment_protection_rule" tabindex="-1"><a class="heading-link" href="#deployment_protection_rule">deployment_protection_rule<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to deployment protection rules. For more information, see "<a href="https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules">Using environments for deployment</a>." For information about the API to manage deployment protection rules, see <a href="https://docs.github.com/rest/deployments/environments">the REST API documentation</a>.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.</p></div><h3>Availability for <code>deployment_protection_rule</code></h3><ul><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>deployment_protection_rule</code></h3><div class="mb-4 f5 color-fg-muted"><p>A deployment protection rule was requested for an environment.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> </div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>requested</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">environment</code> <span class="color-fg-muted pl-2 f5">string</span> </div><div class="pl-1 f5 pt-2"><div><p>The name of the environment that has the deployment protection rule.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">event</code> <span class="color-fg-muted pl-2 f5">string</span> </div><div class="pl-1 f5 pt-2"><div><p>The event that triggered the deployment protection rule.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">deployment_callback_url</code> <span class="color-fg-muted pl-2 f5">string</span> </div><div class="pl-1 f5 pt-2"><div><p>The URL to review the deployment protection rule.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">deployment</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A request for a specific ref(branch,sha,tag) to be deployed</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="deployment" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="deployment_protection_rule--deployment">Properties of <code>deployment</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">pull_requests</code> <span class="color-fg-muted pl-2 f5">array of objects</span> </div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="pull_requests" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="deployment_protection_rule--pull_requests">Properties of <code>pull_requests</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="deployment_review" tabindex="-1"><a class="heading-link" href="#deployment_review">deployment_review<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to deployment reviews. For more information, see "<a href="https://docs.github.com/actions/deployment/about-deployments">About deployments</a>." For information about the APIs to manage deployments, see <a href="https://docs.github.com/graphql/reference/objects#deployment">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/deployments/deployments">Deployments</a>" in the REST API documentation.</p> <p>For activity relating to deployment creation or deployment status, use the <code>deployment</code> or <code>deployment_status</code> event.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.</p></div><h3>Availability for <code>deployment_review</code></h3><ul><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>deployment_review</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd1ukmqn6:-loading-announcement" id=":Rd1ukmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">approved</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A deployment review was approved.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>approved</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">approver</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="approver" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="deployment_review--approver">Properties of <code>approver</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">comment</code> <span class="color-fg-muted pl-2 f5">string</span> </div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">reviewers</code> <span class="color-fg-muted pl-2 f5">array of objects</span> </div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="reviewers" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="deployment_review--reviewers">Properties of <code>reviewers</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">since</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">workflow_job_run</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="workflow_job_run" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="deployment_review--workflow_job_run">Properties of <code>workflow_job_run</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">workflow_job_runs</code> <span class="color-fg-muted pl-2 f5">array of objects</span> </div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="workflow_job_runs" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="deployment_review--workflow_job_runs">Properties of <code>workflow_job_runs</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">workflow_run</code> <span class="color-fg-muted pl-2 f5">object or null</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="workflow_run" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="deployment_review--workflow_run">Properties of <code>workflow_run</code></span></summary></details></td></tr></tbody></table></div></div></div></div><div><div><h2 id="deployment_status" tabindex="-1"><a class="heading-link" href="#deployment_status">deployment_status<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to deployment statuses. For more information, see "<a href="https://docs.github.com/actions/deployment/about-deployments">About deployments</a>." For information about the APIs to manage deployments, see <a href="https://docs.github.com/graphql/reference/objects#deployment">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/deployments/deployments">Deployments</a>" in the REST API documentation.</p> <p>For activity relating to deployment creation, use the <code>deployment</code> event.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.</p> <div class="ghd-alert ghd-alert-accent"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg>Note</p> <p> A webhook event is not fired for deployment statuses with an <code>inactive</code> state.</p> </div></div><h3>Availability for <code>deployment_status</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>deployment_status</code></h3><div class="mb-4 f5 color-fg-muted"><p>A new deployment status was created.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>created</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">check_run</code> <span class="color-fg-muted pl-2 f5">object or null</span> </div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="check_run" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="deployment_status--check_run">Properties of <code>check_run</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">deployment</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The <a href="https://docs.github.com/rest/deployments/deployments#list-deployments">deployment</a>.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="deployment" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="deployment_status--deployment">Properties of <code>deployment</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">deployment_status</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The <a href="https://docs.github.com/rest/deployments/statuses#list-deployment-statuses">deployment status</a>.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="deployment_status" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="deployment_status--deployment_status">Properties of <code>deployment_status</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">workflow</code> <span class="color-fg-muted pl-2 f5">object or null</span> </div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="workflow" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="deployment_status--workflow">Properties of <code>workflow</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">workflow_run</code> <span class="color-fg-muted pl-2 f5">object or null</span> </div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="workflow_run" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="deployment_status--workflow_run">Properties of <code>workflow_run</code></span></summary></details></td></tr></tbody></table></div></div></div></div><div><div><h2 id="discussion" tabindex="-1"><a class="heading-link" href="#discussion">discussion<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a discussion. For more information about discussions, see "<a href="https://docs.github.com/discussions">GitHub Discussions</a>." For information about the API to manage discussions, see <a href="https://docs.github.com/graphql/reference/objects#discussion">the GraphQL documentation</a>.</p> <p>For activity relating to a comment on a discussion, use the <code>discussion_comment</code> event.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.</p> <div class="ghd-alert ghd-alert-accent"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg>Note</p> <p> Webhook events for GitHub Discussions are currently in public preview and subject to change.</p> </div></div><h3>Availability for <code>discussion</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>discussion</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd26kmqn6:-loading-announcement" id=":Rd26kmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">answered</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A comment on the discussion was marked as the answer.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>answered</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">answer</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="answer" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="discussion--answer">Properties of <code>answer</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">discussion</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A Discussion in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="discussion" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="discussion--discussion">Properties of <code>discussion</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="discussion_comment" tabindex="-1"><a class="heading-link" href="#discussion_comment">discussion_comment<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "<a href="https://docs.github.com/discussions">GitHub Discussions</a>." For information about the API to manage discussions, see <a href="https://docs.github.com/graphql/reference/objects#discussion">the GraphQL documentation</a>.</p> <p>For activity relating to a discussion as opposed to comments on a discussion, use the <code>discussion</code> event.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.</p> <div class="ghd-alert ghd-alert-accent"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg>Note</p> <p> Webhook events for GitHub Discussions are currently in public preview and subject to change.</p> </div></div><h3>Availability for <code>discussion_comment</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>discussion_comment</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd2akmqn6:-loading-announcement" id=":Rd2akmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">created</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A comment on a discussion was created.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>created</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">comment</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="comment" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="discussion_comment--comment">Properties of <code>comment</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">discussion</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A Discussion in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="discussion" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="discussion_comment--discussion">Properties of <code>discussion</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="fork" tabindex="-1"><a class="heading-link" href="#fork">fork<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when someone forks a repository. For more information, see "<a href="https://docs.github.com/get-started/quickstart/fork-a-repo">Fork a repo</a>." For information about the API to manage forks, see "<a href="https://docs.github.com/rest/repos/forks">Forks</a>" in the REST API documentation.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.</p></div><h3>Availability for <code>fork</code></h3><ul><li>Enterprises</li><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>fork</code></h3><div class="mb-4 f5 color-fg-muted"></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">forkee</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The created <a href="https://docs.github.com/rest/repos/repos#get-a-repository"><code>repository</code></a> resource.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="forkee" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="fork--forkee">Properties of <code>forkee</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="github_app_authorization" tabindex="-1"><a class="heading-link" href="#github_app_authorization">github_app_authorization<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when a user revokes their authorization of a GitHub App. For more information, see "<a href="https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps">About apps</a>." For information about the API to manage GitHub Apps, see <a href="https://docs.github.com/graphql/reference/objects#app">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/apps">Apps</a>" in the REST API documentation.</p> <p>A GitHub App receives this webhook by default and cannot unsubscribe from this event.</p> <p>Anyone can revoke their authorization of a GitHub App from their <a href="https://github.com/settings/apps/authorizations">GitHub account settings page</a>. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the <code>401 Bad Credentials</code> error. For details about requests with a user access token, which require GitHub App authorization, see "<a href="https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user">Authenticating with a GitHub App on behalf of a user</a>."</p></div><h3>Availability for <code>github_app_authorization</code></h3><ul><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>github_app_authorization</code></h3><div class="mb-4 f5 color-fg-muted"><p>Someone revoked their authorization of a GitHub App.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>revoked</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="gollum" tabindex="-1"><a class="heading-link" href="#gollum">gollum<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when someone creates or updates a wiki page. For more information, see "<a href="https://docs.github.com/communities/documenting-your-project-with-wikis/about-wikis">About wikis</a>."</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.</p></div><h3>Availability for <code>gollum</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>gollum</code></h3><div class="mb-4 f5 color-fg-muted"></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">pages</code> <span class="color-fg-muted pl-2 f5">array of objects</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The pages that were updated.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="pages" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="gollum--pages">Properties of <code>pages</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="installation" tabindex="-1"><a class="heading-link" href="#installation">installation<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p> <p>For more information about GitHub Apps, see "<a href="https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps">About apps</a>." For information about the APIs to manage GitHub Apps, see <a href="https://docs.github.com/graphql/reference/objects#app">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/apps">Apps</a>" in the REST API documentation.</p></div><h3>Availability for <code>installation</code></h3><ul><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>installation</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd2qkmqn6:-loading-announcement" id=":Rd2qkmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">created</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>Someone installed a GitHub App on a user or organization account.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>created</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>Installation</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repositories</code> <span class="color-fg-muted pl-2 f5">array of objects</span> </div><div class="pl-1 f5 pt-2"><div><p>An array of repository objects that the installation can access.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="repositories" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="installation--repositories">Properties of <code>repositories</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">requester</code> <span class="color-fg-muted pl-2 f5">object or null</span> </div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="requester" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="installation--requester">Properties of <code>requester</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="installation_repositories" tabindex="-1"><a class="heading-link" href="#installation_repositories">installation_repositories<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p> <p>For more information about GitHub Apps, see "<a href="https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps">About apps</a>." For information about the APIs to manage GitHub Apps, see <a href="https://docs.github.com/graphql/reference/objects#app">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/apps">Apps</a>" in the REST API documentation.</p></div><h3>Availability for <code>installation_repositories</code></h3><ul><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>installation_repositories</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd2ukmqn6:-loading-announcement" id=":Rd2ukmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">added</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A GitHub App installation was granted access to one or more repositories.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>added</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>Installation</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repositories_added</code> <span class="color-fg-muted pl-2 f5">array of objects</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>An array of repository objects, which were added to the installation.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="repositories_added" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="installation_repositories--repositories_added">Properties of <code>repositories_added</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repositories_removed</code> <span class="color-fg-muted pl-2 f5">array of objects</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>An array of repository objects, which were removed from the installation.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="repositories_removed" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="installation_repositories--repositories_removed">Properties of <code>repositories_removed</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository_selection</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>Describe whether all repositories have been selected or there's a selection involved</p></div><div class="pt-2"><p><span>Can be one of<!-- -->:<!-- --> </span><span><code>all</code>,<!-- --> </span><span><code>selected</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">requester</code> <span class="color-fg-muted pl-2 f5">object or null</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="requester" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="installation_repositories--requester">Properties of <code>requester</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="installation_target" tabindex="-1"><a class="heading-link" href="#installation_target">installation_target<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see "<a href="https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps">About apps</a>." For information about the APIs to manage GitHub Apps, see <a href="https://docs.github.com/graphql/reference/objects#app">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/apps">Apps</a>" in the REST API documentation.</p></div><h3>Availability for <code>installation_target</code></h3><ul><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>installation_target</code></h3><div class="mb-4 f5 color-fg-muted"><p>Somebody renamed the user or organization account that a GitHub App is installed on.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">account</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="account" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="installation_target--account">Properties of <code>account</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>renamed</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">changes</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="changes" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="installation_target--changes">Properties of <code>changes</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">target_type</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="issue_comment" tabindex="-1"><a class="heading-link" href="#issue_comment">issue_comment<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "<a href="https://docs.github.com/issues/tracking-your-work-with-issues/about-issues">About issues</a>" and "<a href="https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests">About pull requests</a>." For information about the APIs to manage issue comments, see <a href="https://docs.github.com/graphql/reference/objects#issuecomment">the GraphQL documentation</a> or "<a href="https://docs.github.com/rest/issues/comments">Issue comments</a>" in the REST API documentation.</p> <p>For activity relating to an issue as opposed to comments on an issue, use the <code>issue</code> event. For activity related to pull request reviews or pull request review comments, use the <code>pull_request_review</code> or <code>pull_request_review_comment</code> events. For more information about the different types of pull request comments, see "<a href="https://docs.github.com/rest/guides/working-with-comments">Working with comments</a>."</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.</p></div><h3>Availability for <code>issue_comment</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>issue_comment</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd36kmqn6:-loading-announcement" id=":Rd36kmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">created</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A comment on an issue or pull request was created.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>created</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">comment</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The <a href="https://docs.github.com/rest/issues/comments#get-an-issue-comment">comment</a> itself.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="comment" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="issue_comment--comment">Properties of <code>comment</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">issue</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The <a href="https://docs.github.com/rest/issues/issues#get-an-issue">issue</a> the comment belongs to.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="issue" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="issue_comment--issue">Properties of <code>issue</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="issues" tabindex="-1"><a class="heading-link" href="#issues">issues<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to an issue. For more information about issues, see "<a href="https://docs.github.com/issues/tracking-your-work-with-issues/about-issues">About issues</a>." For information about the APIs to manage issues, see <a href="https://docs.github.com/graphql/reference/objects#issue">the GraphQL documentation</a> or "<a href="https://docs.github.com/rest/issues">Issues</a>" in the REST API documentation.</p> <p>For activity relating to a comment on an issue, use the <code>issue_comment</code> event.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.</p></div><h3>Availability for <code>issues</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>issues</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd3akmqn6:-loading-announcement" id=":Rd3akmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">assigned</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>An issue was assigned to a user.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The action that was performed.</p></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>assigned</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">assignee</code> <span class="color-fg-muted pl-2 f5">object or null</span> </div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="assignee" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="issues--assignee">Properties of <code>assignee</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">issue</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The <a href="https://docs.github.com/rest/issues/issues#get-an-issue">issue</a> itself.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="issue" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="issues--issue">Properties of <code>issue</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="label" tabindex="-1"><a class="heading-link" href="#label">label<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to labels. For more information, see "<a href="https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels">Managing labels</a>." For information about the APIs to manage labels, see <a href="https://docs.github.com/graphql/reference/objects#label">the GraphQL documentation</a> or "<a href="https://docs.github.com/rest/issues/labels">Labels</a>" in the REST API documentation.</p> <p>If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the <code>labeled</code> or <code>unlabeled</code> action type for the <code>issues</code>, <code>pull_request</code>, or <code>discussion</code> events instead.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.</p></div><h3>Availability for <code>label</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>label</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd3ekmqn6:-loading-announcement" id=":Rd3ekmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">created</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A label was created.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>created</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">label</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="label" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="label--label">Properties of <code>label</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="marketplace_purchase" tabindex="-1"><a class="heading-link" href="#marketplace_purchase">marketplace_purchase<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "<a href="https://docs.github.com/marketplace">GitHub Marketplace</a>." For information about the APIs to manage GitHub Marketplace listings, see <a href="https://docs.github.com/graphql/reference/objects#marketplacelisting">the GraphQL documentation</a> or "<a href="https://docs.github.com/rest/apps/marketplace">GitHub Marketplace</a>" in the REST API documentation.</p></div><h3>Availability for <code>marketplace_purchase</code></h3><ul><li>GitHub Marketplace</li></ul><h3>Webhook payload object for <code>marketplace_purchase</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd3ikmqn6:-loading-announcement" id=":Rd3ikmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">cancelled</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>cancelled</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">effective_date</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">marketplace_purchase</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="marketplace_purchase" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="marketplace_purchase--marketplace_purchase">Properties of <code>marketplace_purchase</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">previous_marketplace_purchase</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="previous_marketplace_purchase" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="marketplace_purchase--previous_marketplace_purchase">Properties of <code>previous_marketplace_purchase</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="member" tabindex="-1"><a class="heading-link" href="#member">member<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to collaborators in a repository. For more information, see "<a href="https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization">Adding outside collaborators to repositories in your organization</a>." For more information about the API to manage repository collaborators, see <a href="https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/collaborators/collaborators">Collaborators</a>" in the REST API documentation.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.</p></div><h3>Availability for <code>member</code></h3><ul><li>Enterprises</li><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>member</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd3mkmqn6:-loading-announcement" id=":Rd3mkmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">added</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A GitHub user accepted an invitation to a repository.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>added</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">changes</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="changes" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="member--changes">Properties of <code>changes</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">member</code> <span class="color-fg-muted pl-2 f5">object or null</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="member" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="member--member">Properties of <code>member</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="membership" tabindex="-1"><a class="heading-link" href="#membership">membership<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to team membership. For more information, see "<a href="https://docs.github.com/organizations/organizing-members-into-teams/about-teams">About teams</a>." For more information about the APIs to manage team memberships, see <a href="https://docs.github.com/graphql/reference/objects#team">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/teams/members">Team members</a>" in the REST API documentation.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.</p></div><h3>Availability for <code>membership</code></h3><ul><li>Organizations</li><li>Enterprises</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>membership</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd3qkmqn6:-loading-announcement" id=":Rd3qkmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">added</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>An organization member was added to a team.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>added</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">member</code> <span class="color-fg-muted pl-2 f5">object or null</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="member" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="membership--member">Properties of <code>member</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">scope</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The scope of the membership. Currently, can only be <code>team</code>.</p></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>team</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object or null</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">team</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>Groups of organization members that gives permissions on specified repositories.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="team" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="membership--team">Properties of <code>team</code></span></summary></details></td></tr></tbody></table></div></div></div></div><div><div><h2 id="merge_group" tabindex="-1"><a class="heading-link" href="#merge_group">merge_group<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "<a href="https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue">Managing a merge queue</a>."</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission.</p></div><h3>Availability for <code>merge_group</code></h3><ul><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>merge_group</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd3ukmqn6:-loading-announcement" id=":Rd3ukmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">checks_requested</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.</p> <p>When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>checks_requested</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">merge_group</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A group of pull requests that the merge queue has grouped together to be merged.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="merge_group" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="merge_group--merge_group">Properties of <code>merge_group</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="meta" tabindex="-1"><a class="heading-link" href="#meta">meta<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a webhook itself.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Meta" app permission.</p></div><h3>Availability for <code>meta</code></h3><ul><li>GitHub Marketplace</li><li>Enterprises</li><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>meta</code></h3><div class="mb-4 f5 color-fg-muted"><p>The webhook was deleted.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>deleted</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">hook</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="hook" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="meta--hook">Properties of <code>hook</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">hook_id</code> <span class="color-fg-muted pl-2 f5">integer</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The id of the modified webhook.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="milestone" tabindex="-1"><a class="heading-link" href="#milestone">milestone<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to milestones. For more information, see "<a href="https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones">About milestones</a>." For information about the APIs to manage milestones, see <a href="https://docs.github.com/graphql/reference/objects#milestone">the GraphQL documentation</a> or "<a href="https://docs.github.com/rest/issues/milestones">Milestones</a>" in the REST API documentation.</p> <p>If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the <code>milestoned</code> or <code>demilestoned</code> action type for the <code>issues</code> or <code>pull_request</code> events instead.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions.</p></div><h3>Availability for <code>milestone</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>milestone</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd46kmqn6:-loading-announcement" id=":Rd46kmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">closed</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A milestone was closed.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>closed</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">milestone</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A collection of related issues and pull requests.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="milestone" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="milestone--milestone">Properties of <code>milestone</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="org_block" tabindex="-1"><a class="heading-link" href="#org_block">org_block<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "<a href="https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization">Blocking a user from your organization</a>." For information about the APIs to manage blocked users, see <a href="https://docs.github.com/graphql/reference/objects#userblockedevent">the GraphQL documentation</a> or "<a href="https://docs.github.com/rest/orgs/blocking">Blocking users</a>" in the REST API documentation.</p> <p>If you want to receive an event when members are added or removed from an organization, use the <code>organization</code> event instead.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission.</p></div><h3>Availability for <code>org_block</code></h3><ul><li>Organizations</li><li>Enterprises</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>org_block</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd4akmqn6:-loading-announcement" id=":Rd4akmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">blocked</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A user was blocked from the organization.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>blocked</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">blocked_user</code> <span class="color-fg-muted pl-2 f5">object or null</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="blocked_user" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="org_block--blocked_user">Properties of <code>blocked_user</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="organization" tabindex="-1"><a class="heading-link" href="#organization">organization<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to an organization and its members. For more information, see "<a href="https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations">About organizations</a>." For information about the APIs to manage organizations, see <a href="https://docs.github.com/graphql/reference/objects#organization">the GraphQL documentation</a> or "<a href="https://docs.github.com/rest/orgs">Organizations</a>" in the REST API documentation.</p> <p>If you want to receive an event when a non-member is blocked or unblocked from an organization, use the <code>org_block</code> event instead.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.</p></div><h3>Availability for <code>organization</code></h3><ul><li>Organizations</li><li>Enterprises</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>organization</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd4ekmqn6:-loading-announcement" id=":Rd4ekmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">deleted</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>An organization was deleted.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>deleted</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">membership</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The membership between the user and the organization. Not present when the action is <code>member_invited</code>.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="membership" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="organization--membership">Properties of <code>membership</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="package" tabindex="-1"><a class="heading-link" href="#package">package<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to GitHub Packages. For more information, see "<a href="https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages">Introduction to GitHub Packages</a>." For information about the APIs to manage GitHub Packages, see <a href="https://docs.github.com/graphql/reference/objects#package">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/packages">Packages</a>" in the REST API documentation.</p> <p>To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission.</p></div><h3>Availability for <code>package</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>package</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd4ikmqn6:-loading-announcement" id=":Rd4ikmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">published</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A package was published to a registry.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>published</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">package</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>Information about the package.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="package" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="package--package">Properties of <code>package</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="page_build" tabindex="-1"><a class="heading-link" href="#page_build">page_build<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see "<a href="https://docs.github.com/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site">Configuring a publishing source for your GitHub Pages site</a>." For information about the API to manage GitHub Pages, see "<a href="https://docs.github.com/rest/pages">Pages</a>" in the REST API documentation.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Pages" repository permission.</p></div><h3>Availability for <code>page_build</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>page_build</code></h3><div class="mb-4 f5 color-fg-muted"></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">build</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The <a href="https://docs.github.com/rest/pages/pages#list-github-pages-builds">List GitHub Pages builds</a> itself.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="build" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="page_build--build">Properties of <code>build</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">id</code> <span class="color-fg-muted pl-2 f5">integer</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="personal_access_token_request" tabindex="-1"><a class="heading-link" href="#personal_access_token_request">personal_access_token_request<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "<a href="https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token">Creating a personal access token</a>."</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission.</p> <div class="ghd-alert ghd-alert-accent"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg>Note</p> <p> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.</p> </div></div><h3>Availability for <code>personal_access_token_request</code></h3><ul><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>personal_access_token_request</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd4qkmqn6:-loading-announcement" id=":Rd4qkmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">approved</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A fine-grained personal access token request was approved.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>approved</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">personal_access_token_request</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>Details of a Personal Access Token Request.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="personal_access_token_request" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="personal_access_token_request--personal_access_token_request">Properties of <code>personal_access_token_request</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="ping" tabindex="-1"><a class="heading-link" href="#ping">ping<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.</p></div><h3>Availability for <code>ping</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li><li>Enterprises</li><li>GitHub Marketplace</li></ul><h3>Webhook payload object for <code>ping</code></h3><div class="mb-4 f5 color-fg-muted"></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">hook</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The webhook that is being pinged</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="hook" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="ping--hook">Properties of <code>hook</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">hook_id</code> <span class="color-fg-muted pl-2 f5">integer</span> </div><div class="pl-1 f5 pt-2"><div><p>The ID of the webhook that triggered the ping.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">zen</code> <span class="color-fg-muted pl-2 f5">string</span> </div><div class="pl-1 f5 pt-2"><div><p>Random string of GitHub zen.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="project_card" tabindex="-1"><a class="heading-link" href="#project_card">project_card<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a card on a project (classic). For more information, see "<a href="https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards">About projects (classic)</a>." For information about the API to manage classic projects, see <a href="https://docs.github.com/graphql/reference/objects#project">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/projects">Projects (classic)</a>" in the REST API documentation.</p> <p>For activity relating to a project (classic) or a column on a project (classic), use the <code>project</code> and <code>project_column</code> event.</p> <p>This event relates to projects (classic) only. For activity relating to the new Projects experience, use the <code>projects_v2</code> event instead.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.</p></div><h3>Availability for <code>project_card</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>project_card</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd52kmqn6:-loading-announcement" id=":Rd52kmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">converted</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A note in a project (classic) was converted to an issue.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>converted</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">changes</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="changes" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="project_card--changes">Properties of <code>changes</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">project_card</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="project_card" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="project_card--project_card">Properties of <code>project_card</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="project" tabindex="-1"><a class="heading-link" href="#project">project<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a project (classic). For more information, see "<a href="https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards">About projects (classic)</a>." For information about the API to manage classic projects, see <a href="https://docs.github.com/graphql/reference/objects#project">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/projects">Projects (classic)</a>" in the REST API documentation.</p> <p>For activity relating to a card or column on a project (classic), use the <code>project_card</code> and <code>project_column</code> event.</p> <p>This event relates to projects (classic) only. For activity relating to the new Projects experience, use the <code>projects_v2</code> event instead.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.</p></div><h3>Availability for <code>project</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>project</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd56kmqn6:-loading-announcement" id=":Rd56kmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">closed</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A project (classic) was closed.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>closed</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">project</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="project" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="project--project">Properties of <code>project</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="project_column" tabindex="-1"><a class="heading-link" href="#project_column">project_column<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a column on a project (classic). For more information, see "<a href="https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards">About projects (classic)</a>." For information about the API to manage classic projects, see <a href="https://docs.github.com/graphql/reference/objects#project">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/projects">Projects (classic)</a>" in the REST API documentation.</p> <p>For activity relating to a project (classic) or a card on a project (classic), use the <code>project</code> and <code>project_card</code> event.</p> <p>This event relates to projects (classic) only. For activity relating to the new Projects experience, use the <code>projects_v2</code> event instead.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.</p></div><h3>Availability for <code>project_column</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>project_column</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd5akmqn6:-loading-announcement" id=":Rd5akmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">created</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A column was added to a project (classic).</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>created</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">project_column</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="project_column" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="project_column--project_column">Properties of <code>project_column</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="projects_v2" tabindex="-1"><a class="heading-link" href="#projects_v2">projects_v2<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to an organization-level project. For more information, see "<a href="https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects">About Projects</a>." For information about the Projects API, see <a href="https://docs.github.com/graphql/reference/objects#projectv2">the GraphQL documentation</a>.</p> <p>For activity relating to a item on a project, use the <code>projects_v2_item</code> event. For activity relating to Projects (classic), use the <code>project</code>, <code>project_card</code>, and <code>project_column</code> events instead.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.</p> <div class="ghd-alert ghd-alert-accent"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg>Note</p> <p> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the <a href="https://github.com/orgs/community/discussions/17405">Projects webhook feedback discussion</a>.</p> </div></div><h3>Availability for <code>projects_v2</code></h3><ul><li>Organizations</li></ul><h3>Webhook payload object for <code>projects_v2</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd5ekmqn6:-loading-announcement" id=":Rd5ekmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">closed</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A project in the organization was closed.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>closed</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">projects_v2</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A projects v2 project</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="projects_v2" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="projects_v2--projects_v2">Properties of <code>projects_v2</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="projects_v2_item" tabindex="-1"><a class="heading-link" href="#projects_v2_item">projects_v2_item<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to an item on an organization-level project. For more information, see "<a href="https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects">About Projects</a>." For information about the Projects API, see <a href="https://docs.github.com/graphql/reference/objects#projectv2item">the GraphQL documentation</a>.</p> <p>For activity relating to a project (instead of an item on a project), use the <code>projects_v2</code> event. For activity relating to Projects (classic), use the <code>project</code>, <code>project_card</code>, and <code>project_column</code> events instead.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.</p> <div class="ghd-alert ghd-alert-accent"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg>Note</p> <p> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the <a href="https://github.com/orgs/community/discussions/17405">Projects webhook feedback discussion</a>.</p> </div></div><h3>Availability for <code>projects_v2_item</code></h3><ul><li>Organizations</li></ul><h3>Webhook payload object for <code>projects_v2_item</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd5ikmqn6:-loading-announcement" id=":Rd5ikmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">archived</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>An item on an organization project was archived. For more information, see "<a href="https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project">Archiving items from your project</a>."</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>archived</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">changes</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="changes" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="projects_v2_item--changes">Properties of <code>changes</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">projects_v2_item</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>An item belonging to a project</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="projects_v2_item" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="projects_v2_item--projects_v2_item">Properties of <code>projects_v2_item</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="projects_v2_status_update" tabindex="-1"><a class="heading-link" href="#projects_v2_status_update">projects_v2_status_update<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "<a href="https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects">About Projects</a>."</p> <p>For activity relating to a project, use the <code>projects_v2</code> event.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.</p> <div class="ghd-alert ghd-alert-accent"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg>Note</p> <p> To share feedback about projects webhooks with GitHub, see the <a href="https://github.com/orgs/community/discussions/17405">Projects webhook feedback discussion</a>.</p> </div></div><h3>Availability for <code>projects_v2_status_update</code></h3><ul><li>Organizations</li></ul><h3>Webhook payload object for <code>projects_v2_status_update</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd5mkmqn6:-loading-announcement" id=":Rd5mkmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">created</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A status update was added to a project in the organization.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>created</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">projects_v2_status_update</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>An status update belonging to a project</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="projects_v2_status_update" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="projects_v2_status_update--projects_v2_status_update">Properties of <code>projects_v2_status_update</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="public" tabindex="-1"><a class="heading-link" href="#public">public<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when repository visibility changes from private to public. For more information, see "<a href="https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility">Setting repository visibility</a>."</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.</p></div><h3>Availability for <code>public</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>public</code></h3><div class="mb-4 f5 color-fg-muted"></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="pull_request" tabindex="-1"><a class="heading-link" href="#pull_request">pull_request<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity on a pull request. For more information, see "<a href="https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests">About pull requests</a>." For information about the APIs to manage pull requests, see <a href="https://docs.github.com/graphql/reference/objects#pullrequest">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/pulls/pulls">Pulls</a>" in the REST API documentation.</p> <p>For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the <code>pull_request_review</code>, <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review_thread</code> events instead.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.</p></div><h3>Availability for <code>pull_request</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>pull_request</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd5ukmqn6:-loading-announcement" id=":Rd5ukmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">assigned</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A pull request was assigned to a user.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>assigned</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">assignee</code> <span class="color-fg-muted pl-2 f5">object or null</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="assignee" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="pull_request--assignee">Properties of <code>assignee</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">number</code> <span class="color-fg-muted pl-2 f5">integer</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The pull request number.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">pull_request</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="pull_request" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="pull_request--pull_request">Properties of <code>pull_request</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="pull_request_review_comment" tabindex="-1"><a class="heading-link" href="#pull_request_review_comment">pull_request_review_comment<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "<a href="https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request">Commenting on a pull request</a>." For information about the APIs to manage pull request review comments, see <a href="https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/pulls/comments">Pull request review comments</a>" in the REST API documentation.</p> <p>For activity related to pull request reviews, pull request comments, or pull request review threads, use the <code>pull_request_review</code>, <code>issue_comment</code>, or <code>pull_request_review_thread</code> events instead.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.</p></div><h3>Availability for <code>pull_request_review_comment</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>pull_request_review_comment</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd62kmqn6:-loading-announcement" id=":Rd62kmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">created</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A comment on a pull request diff was created.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>created</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">comment</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The <a href="https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request">comment</a> itself.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="comment" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="pull_request_review_comment--comment">Properties of <code>comment</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">pull_request</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="pull_request" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="pull_request_review_comment--pull_request">Properties of <code>pull_request</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="pull_request_review" tabindex="-1"><a class="heading-link" href="#pull_request_review">pull_request_review<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "<a href="https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews">About pull request reviews</a>." For information about the APIs to manage pull request reviews, see <a href="https://docs.github.com/graphql/reference/objects#pullrequestreview">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/pulls/reviews">Pull request reviews</a>" in the REST API documentation.</p> <p>For activity related to pull request review comments, pull request comments, or pull request review threads, use the <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review_thread</code> events instead.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.</p></div><h3>Availability for <code>pull_request_review</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>pull_request_review</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd66kmqn6:-loading-announcement" id=":Rd66kmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">dismissed</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A review on a pull request was dismissed.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>dismissed</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">pull_request</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="pull_request" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="pull_request_review--pull_request">Properties of <code>pull_request</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">review</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The review that was affected.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="review" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="pull_request_review--review">Properties of <code>review</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="pull_request_review_thread" tabindex="-1"><a class="heading-link" href="#pull_request_review_thread">pull_request_review_thread<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "<a href="https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews">About pull request reviews</a>." For information about the APIs to manage pull request reviews, see <a href="https://docs.github.com/graphql/reference/objects#pullrequestreviewthread">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/pulls/comments">Pull request review comments</a>" in the REST API documentation.</p> <p>For activity related to pull request review comments, pull request comments, or pull request reviews, use the <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review</code> events instead.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.</p></div><h3>Availability for <code>pull_request_review_thread</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>pull_request_review_thread</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd6akmqn6:-loading-announcement" id=":Rd6akmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">resolved</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A comment thread on a pull request was marked as resolved.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>resolved</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">pull_request</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="pull_request" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="pull_request_review_thread--pull_request">Properties of <code>pull_request</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">thread</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="thread" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="pull_request_review_thread--thread">Properties of <code>thread</code></span></summary></details></td></tr></tbody></table></div></div></div></div><div><div><h2 id="push" tabindex="-1"><a class="heading-link" href="#push">push<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch and tag deletions, use the <a href="#delete"><code>delete</code></a> webhook event.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.</p> <div class="ghd-alert ghd-alert-accent"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg>Note</p> <p> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.</p> </div></div><h3>Availability for <code>push</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>push</code></h3><div class="mb-4 f5 color-fg-muted"></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">after</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The SHA of the most recent commit on <code>ref</code> after the push.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">base_ref</code> <span class="color-fg-muted pl-2 f5">string or null</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">before</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The SHA of the most recent commit on <code>ref</code> before the push.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">commits</code> <span class="color-fg-muted pl-2 f5">array of objects</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the <code>compare</code> between the <code>before</code> commit and the <code>after</code> commit.) The array includes a maximum of 2048 commits. If necessary, you can use the <a href="https://docs.github.com/rest/commits">Commits API</a> to fetch additional commits.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="commits" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="push--commits">Properties of <code>commits</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">compare</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>URL that shows the changes in this <code>ref</code> update, from the <code>before</code> commit to the <code>after</code> commit. For a newly created <code>ref</code> that is directly based on the default branch, this is the comparison between the head of the default branch and the <code>after</code> commit. Otherwise, this shows all commits until the <code>after</code> commit.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">created</code> <span class="color-fg-muted pl-2 f5">boolean</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>Whether this push created the <code>ref</code>.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">deleted</code> <span class="color-fg-muted pl-2 f5">boolean</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>Whether this push deleted the <code>ref</code>.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">forced</code> <span class="color-fg-muted pl-2 f5">boolean</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>Whether this push was a force push of the <code>ref</code>.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">head_commit</code> <span class="color-fg-muted pl-2 f5">object or null</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="head_commit" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="push--head_commit">Properties of <code>head_commit</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">pusher</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>Metaproperties for Git author/committer information.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="pusher" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="push--pusher">Properties of <code>pusher</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">ref</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The full git ref that was pushed. Example: <code>refs/heads/main</code> or <code>refs/tags/v3.14.1</code>.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A git repository</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="registry_package" tabindex="-1"><a class="heading-link" href="#registry_package">registry_package<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to GitHub Packages. For more information, see "<a href="https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages">Introduction to GitHub Packages</a>." For information about the APIs to manage GitHub Packages, see <a href="https://docs.github.com/graphql/reference/objects#package">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/packages">Packages</a>" in the REST API documentation.</p> <p>To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission.</p> <div class="ghd-alert ghd-alert-accent"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg>Note</p> <p> GitHub recommends that you use the newer <code>package</code> event instead.</p> </div></div><h3>Availability for <code>registry_package</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>registry_package</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd6ikmqn6:-loading-announcement" id=":Rd6ikmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">published</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A package was published to a registry.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>published</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">registry_package</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="registry_package" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="registry_package--registry_package">Properties of <code>registry_package</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="release" tabindex="-1"><a class="heading-link" href="#release">release<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to releases. For more information, see "<a href="https://docs.github.com/repositories/releasing-projects-on-github/about-releases">About releases</a>." For information about the APIs to manage releases, see <a href="https://docs.github.com/graphql/reference/objects#release">the GraphQL API documentation</a> or "<a href="https://docs.github.com/rest/releases">Releases</a>" in the REST API documentation.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.</p></div><h3>Availability for <code>release</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>release</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd6mkmqn6:-loading-announcement" id=":Rd6mkmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">created</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A draft was saved, or a release or pre-release was published without previously being saved as a draft.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>created</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">release</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The <a href="https://docs.github.com/rest/releases/releases/#get-a-release">release</a> object.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="release" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="release--release">Properties of <code>release</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="repository_advisory" tabindex="-1"><a class="heading-link" href="#repository_advisory">repository_advisory<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "<a href="https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories">About GitHub Security Advisories for repositories</a>."</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission.</p></div><h3>Availability for <code>repository_advisory</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>repository_advisory</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd6qkmqn6:-loading-announcement" id=":Rd6qkmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">published</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A repository security advisory was published.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>published</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository_advisory</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A repository security advisory.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="repository_advisory" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="repository_advisory--repository_advisory">Properties of <code>repository_advisory</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="repository" tabindex="-1"><a class="heading-link" href="#repository">repository<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to repositories. For more information, see "<a href="https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories">About repositories</a>." For information about the APIs to manage repositories, see <a href="https://docs.github.com/graphql/reference/objects#repository">the GraphQL documentation</a> or "<a href="https://docs.github.com/rest/repos">Repositories</a>" in the REST API documentation.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.</p></div><h3>Availability for <code>repository</code></h3><ul><li>Enterprises</li><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>repository</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd6ukmqn6:-loading-announcement" id=":Rd6ukmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">archived</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A repository was archived.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>archived</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="repository_dispatch" tabindex="-1"><a class="heading-link" href="#repository_dispatch">repository_dispatch<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when a GitHub App sends a <code>POST</code> request to <code>/repos/{owner}/{repo}/dispatches</code>. For more information, see <a href="https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event">the REST API documentation for creating a repository dispatch event</a>. In the payload, the <code>action</code> will be the <code>event_type</code> that was specified in the <code>POST /repos/{owner}/{repo}/dispatches</code> request body.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.</p></div><h3>Availability for <code>repository_dispatch</code></h3><ul><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>repository_dispatch</code></h3><div class="mb-4 f5 color-fg-muted"></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The <code>event_type</code> that was specified in the <code>POST /repos/{owner}/{repo}/dispatches</code> request body.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">branch</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">client_payload</code> <span class="color-fg-muted pl-2 f5">object or null</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The <code>client_payload</code> that was specified in the <code>POST /repos/{owner}/{repo}/dispatches</code> request body.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="repository_import" tabindex="-1"><a class="heading-link" href="#repository_import">repository_import<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when a repository is imported to GitHub. For more information, see "<a href="https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer">Importing a repository with GitHub Importer</a>." For more information about the API to manage imports, see <a href="https://docs.github.com/rest/migrations/source-imports">the REST API documentation</a>.</p></div><h3>Availability for <code>repository_import</code></h3><ul><li>Repositories</li><li>Organizations</li></ul><h3>Webhook payload object for <code>repository_import</code></h3><div class="mb-4 f5 color-fg-muted"></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">status</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Can be one of<!-- -->:<!-- --> </span><span><code>success</code>,<!-- --> </span><span><code>cancelled</code>,<!-- --> </span><span><code>failure</code> </span></p></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="repository_ruleset" tabindex="-1"><a class="heading-link" href="#repository_ruleset">repository_ruleset<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to repository rulesets. For more information about repository rulesets, see "<a href="https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets">Managing rulesets</a>." For more information on managing rulesets via the APIs, see <a href="https://docs.github.com/graphql/reference/objects#repositoryruleset">Repository ruleset</a> in the GraphQL documentation or "<a href="https://docs.github.com/rest/repos/rules">Repository rules</a>" and "<a href="https://docs.github.com/rest/orgs/rules">Organization rules</a> in the REST API documentation."</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission.</p></div><h3>Availability for <code>repository_ruleset</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>repository_ruleset</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd7akmqn6:-loading-announcement" id=":Rd7akmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">created</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A repository ruleset was created.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>created</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository_ruleset</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A set of rules to apply when specified conditions are met.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="repository_ruleset" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="repository_ruleset--repository_ruleset">Properties of <code>repository_ruleset</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="repository_vulnerability_alert" tabindex="-1"><a class="heading-link" href="#repository_vulnerability_alert">repository_vulnerability_alert<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a security vulnerability alert in a repository.</p> <div class="ghd-alert ghd-alert-attention"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></svg>Warning</p> <p> <strong>Closing down notice:</strong> This event is closing down. Use the <code>dependabot_alert</code> event instead.</p> </div></div><h3>Availability for <code>repository_vulnerability_alert</code></h3><ul><li>Repositories</li><li>Organizations</li></ul><h3>Webhook payload object for <code>repository_vulnerability_alert</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd7ekmqn6:-loading-announcement" id=":Rd7ekmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">create</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A repository vulnerability alert was created.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>create</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">alert</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The security alert of the vulnerable dependency.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="alert" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="repository_vulnerability_alert--alert">Properties of <code>alert</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="secret_scanning_alert" tabindex="-1"><a class="heading-link" href="#secret_scanning_alert">secret_scanning_alert<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "<a href="https://docs.github.com/code-security/secret-scanning/about-secret-scanning">About secret scanning</a>." For information about the API to manage secret scanning alerts, see "<a href="https://docs.github.com/rest/secret-scanning">Secret scanning</a>" in the REST API documentation.</p> <p>For activity relating to secret scanning alert locations, use the <code>secret_scanning_alert_location</code> event.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.</p></div><h3>Availability for <code>secret_scanning_alert</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>secret_scanning_alert</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd7ikmqn6:-loading-announcement" id=":Rd7ikmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">created</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A secret scanning alert was created.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>created</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">alert</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="alert" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="secret_scanning_alert--alert">Properties of <code>alert</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="secret_scanning_alert_location" tabindex="-1"><a class="heading-link" href="#secret_scanning_alert_location">secret_scanning_alert_location<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.</p> <p>For more information about secret scanning, see "<a href="https://docs.github.com/code-security/secret-scanning/about-secret-scanning">About secret scanning</a>." For information about the API to manage secret scanning alerts, see "<a href="https://docs.github.com/rest/secret-scanning">Secret scanning</a>" in the REST API documentation.</p> <p>For activity relating to secret scanning alerts, use the <code>secret_scanning_alert</code> event.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.</p></div><h3>Availability for <code>secret_scanning_alert_location</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>secret_scanning_alert_location</code></h3><div class="mb-4 f5 color-fg-muted"><p>A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> </div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>created</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">alert</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="alert" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="secret_scanning_alert_location--alert">Properties of <code>alert</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">location</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="location" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="secret_scanning_alert_location--location">Properties of <code>location</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="secret_scanning_scan" tabindex="-1"><a class="heading-link" href="#secret_scanning_scan">secret_scanning_scan<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "<a href="https://docs.github.com/code-security/secret-scanning/about-secret-scanning">About secret scanning</a>."</p> <p>Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates to patterns from partners. For more information on custom patterns, see "<a href="https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns">About custom patterns</a>."</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.</p></div><h3>Availability for <code>secret_scanning_scan</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>secret_scanning_scan</code></h3><div class="mb-4 f5 color-fg-muted"><p>A secret scanning scan was completed.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>completed</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">type</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>What type of scan was completed</p></div><div class="pt-2"><p><span>Can be one of<!-- -->:<!-- --> </span><span><code>backfill</code>,<!-- --> </span><span><code>custom-pattern-backfill</code>,<!-- --> </span><span><code>pattern-version-backfill</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">source</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>What type of content was scanned</p></div><div class="pt-2"><p><span>Can be one of<!-- -->:<!-- --> </span><span><code>git</code>,<!-- --> </span><span><code>issues</code>,<!-- --> </span><span><code>pull-requests</code>,<!-- --> </span><span><code>discussions</code>,<!-- --> </span><span><code>wiki</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">started_at</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The time that the alert was resolved in ISO 8601 format: <code>YYYY-MM-DDTHH:MM:SSZ</code>.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">completed_at</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The time that the alert was resolved in ISO 8601 format: <code>YYYY-MM-DDTHH:MM:SSZ</code>.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">secret_types</code> <span class="color-fg-muted pl-2 f5">array of strings or null</span> </div><div class="pl-1 f5 pt-2"><div><p>List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">custom_pattern_name</code> <span class="color-fg-muted pl-2 f5">string or null</span> </div><div class="pl-1 f5 pt-2"><div><p>If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">custom_pattern_scope</code> <span class="color-fg-muted pl-2 f5">string or null</span> </div><div class="pl-1 f5 pt-2"><div><p>If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated</p></div><div class="pt-2"><p><span>Can be one of<!-- -->:<!-- --> </span><span><code>repository</code>,<!-- --> </span><span><code>organization</code>,<!-- --> </span><span><code>enterprise</code>,<!-- --> </span><span><code><i>null</i></code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="security_advisory" tabindex="-1"><a class="heading-link" href="#security_advisory">security_advisory<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "<a href="https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories">About global security advisories</a>." For information about the API to manage security advisories, see <a href="https://docs.github.com/rest/security-advisories/global-advisories">the REST API documentation</a> or <a href="https://docs.github.com/graphql/reference/objects#securityadvisory">the GraphQL documentation</a>.</p> <p>GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "<a href="https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts">About Dependabot alerts</a>."</p></div><h3>Availability for <code>security_advisory</code></h3><ul><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>security_advisory</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd7ukmqn6:-loading-announcement" id=":Rd7ukmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">published</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A security advisory was published to the GitHub community.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>published</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">security_advisory</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The details of the security advisory, including summary, description, and severity.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="security_advisory" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="security_advisory--security_advisory">Properties of <code>security_advisory</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="security_and_analysis" tabindex="-1"><a class="heading-link" href="#security_and_analysis">security_and_analysis<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "<a href="https://docs.github.com/code-security/getting-started/github-security-features">GitHub security features</a>."</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.</p></div><h3>Availability for <code>security_and_analysis</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>security_and_analysis</code></h3><div class="mb-4 f5 color-fg-muted"></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">changes</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="changes" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="security_and_analysis--changes">Properties of <code>changes</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>Full Repository</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="sponsorship" tabindex="-1"><a class="heading-link" href="#sponsorship">sponsorship<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a sponsorship listing. For more information, see "<a href="https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors">About GitHub Sponsors</a>." For information about the API to manage sponsors, see <a href="https://docs.github.com/graphql/reference/objects#sponsorship">the GraphQL documentation</a>.</p> <p>You can only create a sponsorship webhook on GitHub.com. For more information, see "<a href="https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account">Configuring webhooks for events in your sponsored account</a>."</p></div><h3>Availability for <code>sponsorship</code></h3><ul><li>Sponsored accounts</li></ul><h3>Webhook payload object for <code>sponsorship</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd86kmqn6:-loading-announcement" id=":Rd86kmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">cancelled</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A sponsorship was cancelled and the last billing cycle has ended.</p> <p>This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>cancelled</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sponsorship</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="sponsorship" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="sponsorship--sponsorship">Properties of <code>sponsorship</code></span></summary></details></td></tr></tbody></table></div></div></div></div><div><div><h2 id="star" tabindex="-1"><a class="heading-link" href="#star">star<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to repository stars. For more information about stars, see "<a href="https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars">Saving repositories with stars</a>." For information about the APIs to manage stars, see <a href="https://docs.github.com/graphql/reference/objects#starredrepositoryconnection">the GraphQL documentation</a> or "<a href="https://docs.github.com/rest/activity/starring">Starring</a>" in the REST API documentation.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.</p></div><h3>Availability for <code>star</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>star</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd8akmqn6:-loading-announcement" id=":Rd8akmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">created</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>Someone starred a repository.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>created</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">starred_at</code> <span class="color-fg-muted pl-2 f5">string or null</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The time the star was created. This is a timestamp in ISO 8601 format: <code>YYYY-MM-DDTHH:MM:SSZ</code>. Will be <code>null</code> for the <code>deleted</code> action.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="status" tabindex="-1"><a class="heading-link" href="#status">status<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when the status of a Git commit changes. For example, commits can be marked as <code>error</code>, <code>failure</code>, <code>pending</code>, or <code>success</code>. For more information, see "<a href="https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks">About status checks</a>." For information about the APIs to manage commit statuses, see <a href="https://docs.github.com/graphql/reference/objects#status">the GraphQL documentation</a> or "<a href="https://docs.github.com/rest/commits/statuses">Commit statuses</a>" in the REST API documentation.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission.</p></div><h3>Availability for <code>status</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>status</code></h3><div class="mb-4 f5 color-fg-muted"></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">avatar_url</code> <span class="color-fg-muted pl-2 f5">string or null</span> </div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">branches</code> <span class="color-fg-muted pl-2 f5">array of objects</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="branches" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="status--branches">Properties of <code>branches</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">commit</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="commit" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="status--commit">Properties of <code>commit</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">context</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">created_at</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">description</code> <span class="color-fg-muted pl-2 f5">string or null</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The optional human-readable description added to the status.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">id</code> <span class="color-fg-muted pl-2 f5">integer</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The unique identifier of the status.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">name</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sha</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The Commit SHA.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">state</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The new state. Can be <code>pending</code>, <code>success</code>, <code>failure</code>, or <code>error</code>.</p></div><div class="pt-2"><p><span>Can be one of<!-- -->:<!-- --> </span><span><code>pending</code>,<!-- --> </span><span><code>success</code>,<!-- --> </span><span><code>failure</code>,<!-- --> </span><span><code>error</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">target_url</code> <span class="color-fg-muted pl-2 f5">string or null</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The optional link added to the status.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">updated_at</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="sub_issues" tabindex="-1"><a class="heading-link" href="#sub_issues">sub_issues<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to sub-issues.</p> <p>For activity relating to issues more generally, use the <code>issues</code> event instead.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions.</p></div><h3>Availability for <code>sub_issues</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>sub_issues</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd8ikmqn6:-loading-announcement" id=":Rd8ikmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">parent_issue_added</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A parent issue was added to an issue.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>parent_issue_added</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">parent_issue_id</code> <span class="color-fg-muted pl-2 f5">number</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The ID of the parent issue.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">parent_issue</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="parent_issue" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="sub_issues--parent_issue">Properties of <code>parent_issue</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">parent_issue_repo</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A repository on GitHub.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="parent_issue_repo" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="sub_issues--parent_issue_repo">Properties of <code>parent_issue_repo</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sub_issue_id</code> <span class="color-fg-muted pl-2 f5">number</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The ID of the sub-issue.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sub_issue</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="sub_issue" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="sub_issues--sub_issue">Properties of <code>sub_issue</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="team_add" tabindex="-1"><a class="heading-link" href="#team_add">team_add<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when a team is added to a repository. For more information, see "<a href="https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository">Managing teams and people with access to your repository</a>."</p> <p>For activity relating to teams, see the <code>teams</code> event.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.</p></div><h3>Availability for <code>team_add</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>team_add</code></h3><div class="mb-4 f5 color-fg-muted"></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">team</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>Groups of organization members that gives permissions on specified repositories.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="team" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="team_add--team">Properties of <code>team</code></span></summary></details></td></tr></tbody></table></div></div></div></div><div><div><h2 id="team" tabindex="-1"><a class="heading-link" href="#team">team<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to teams in an organization. For more information, see "<a href="https://docs.github.com/organizations/organizing-members-into-teams/about-teams">About teams</a>."</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.</p></div><h3>Availability for <code>team</code></h3><ul><li>Organizations</li><li>Enterprises</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>team</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd8qkmqn6:-loading-announcement" id=":Rd8qkmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">added_to_repository</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A team was granted access to a repository.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>added_to_repository</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A git repository</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">team</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>Groups of organization members that gives permissions on specified repositories.</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="team" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="team--team">Properties of <code>team</code></span></summary></details></td></tr></tbody></table></div></div></div></div><div><div><h2 id="watch" tabindex="-1"><a class="heading-link" href="#watch">watch<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see "<a href="https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions">Managing your subscriptions</a>." For information about the APIs to manage watching, see "<a href="https://docs.github.com/rest/activity/watching">Watching</a>" in the REST API documentation.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.</p></div><h3>Availability for <code>watch</code></h3><ul><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>watch</code></h3><div class="mb-4 f5 color-fg-muted"><p>Someone started watching the repository.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>started</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="workflow_dispatch" tabindex="-1"><a class="heading-link" href="#workflow_dispatch">workflow_dispatch<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "<a href="https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow">Manually running a workflow</a>."</p> <p>For activity relating to workflow runs, use the <code>workflow_run</code> event.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.</p></div><h3>Availability for <code>workflow_dispatch</code></h3><ul><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>workflow_dispatch</code></h3><div class="mb-4 f5 color-fg-muted"></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">inputs</code> <span class="color-fg-muted pl-2 f5">object or null</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">ref</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">workflow</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr></tbody></table></div></div></div></div><div><div><h2 id="workflow_job" tabindex="-1"><a class="heading-link" href="#workflow_job">workflow_job<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "<a href="https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow">Using jobs in a workflow</a>." For information about the API to manage workflow jobs, see "<a href="https://docs.github.com/rest/actions/workflow-jobs">Workflow jobs</a>" in the REST API documentation.</p> <p>For activity relating to a workflow run instead of a job in a workflow run, use the <code>workflow_run</code> event.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.</p></div><h3>Availability for <code>workflow_job</code></h3><ul><li>Enterprises</li><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>workflow_job</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd96kmqn6:-loading-announcement" id=":Rd96kmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">completed</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>completed</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">workflow_job</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="workflow_job" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="workflow_job--workflow_job">Properties of <code>workflow_job</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">deployment</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A request for a specific ref(branch,sha,tag) to be deployed</p></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="deployment" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="workflow_job--deployment">Properties of <code>deployment</code></span></summary></details></td></tr></tbody></table></div></div></div></div><div><div><h2 id="workflow_run" tabindex="-1"><a class="heading-link" href="#workflow_run">workflow_run<span aria-hidden="true" class="heading-link-symbol"></span></a></h2><div><div><p>This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "<a href="https://docs.github.com/actions/using-workflows/about-workflows">About workflows</a>." For information about the APIs to manage workflow runs, see <a href="https://docs.github.com/graphql/reference/objects#workflowrun">the GraphQL documentation</a> or "<a href="https://docs.github.com/rest/actions/workflow-runs">Workflow runs</a>" in the REST API documentation.</p> <p>For activity relating to a job in a workflow run, use the <code>workflow_job</code> event.</p> <p>To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.</p></div><h3>Availability for <code>workflow_run</code></h3><ul><li>Enterprises</li><li>Repositories</li><li>Organizations</li><li>GitHub Apps</li></ul><h3>Webhook payload object for <code>workflow_run</code></h3><div class="mb-4"><div class="mb-3"><button type="button" class="types__StyledButton-sc-ws60qy-0 hmWbvh text-normal" aria-haspopup="true" aria-expanded="false" tabindex="0" data-loading="false" aria-describedby=":Rd9akmqn6:-loading-announcement" id=":Rd9akmqn6:"><span data-component="buttonContent" class="Box-sc-g0xbh4-0 cEhRXB"><span data-component="text">Action type<!-- -->: <span class="text-bold">completed</span></span></span><span data-component="trailingAction" class="Box-sc-g0xbh4-0 dmdEgz"><svg aria-hidden="true" focusable="false" class="octicon octicon-triangle-down" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg></span></button></div></div><div class="mb-4 f5 color-fg-muted"><p>A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.</p></div><div><table class="ParameterTable_parameterTable__NVZ8g" summary="Column one describes the parameter. The first line includes the name, type, and whether the parameter is required. The second line is a description of the parameter." aria-labelledby="body-table-heading"><caption class="mt-3 mb-3 h5 float-left">Webhook request body parameters</caption><thead class="visually-hidden"><tr><th scope="col">Name, Type, Description</th></tr></thead><tbody><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">action</code> <span class="color-fg-muted pl-2 f5">string</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-2"><p><span>Value<!-- -->:<!-- --> </span><span><code>completed</code> </span></p></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">enterprise</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "<a href="https://docs.github.com/admin/overview/about-enterprise-accounts">About enterprise accounts</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">installation</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured for and sent to a GitHub App. For more information, see "<a href="https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps">Using webhooks with GitHub Apps</a>."</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">organization</code> <span class="color-fg-muted pl-2 f5">object</span> </div><div class="pl-1 f5 pt-2"><div><p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">repository</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property when the event occurs from activity in a repository.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">sender</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-2"><div><p>A GitHub user.</p></div><div class="pt-0"></div></div></div></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">workflow</code> <span class="color-fg-muted pl-2 f5">object or null</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="workflow" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="workflow_run--workflow">Properties of <code>workflow</code></span></summary></details></td></tr><tr class=""><td class=""><div class="pl-0 pt-1 pr-1 pb-1"><div><code class="text-bold f5">workflow_run</code> <span class="color-fg-muted pl-2 f5">object</span> <span class="color-fg-attention f5 pl-3">Required</span></div><div class="pl-1 f5 pt-0"><div></div><div class="pt-0"></div></div></div></td></tr><tr class="border-top-0"><td class="has-nested-table"><details data-nested-param-id="workflow_run" class="box px-3 ml-1 mb-0"><summary role="button" aria-expanded="false" class="mb-2 keyboard-focus"><span id="workflow_run--workflow_run">Properties of <code>workflow_run</code></span></summary></details></td></tr></tbody></table></div></div></div></div></div></div></div></div></div></main><footer data-container="footer"><section class="container-xl mt-lg-8 mt-6 px-3 px-md-6 no-print mx-auto"><h2 class="f3">Help and support</h2><div class="container-xl mx-auto py-6 py-lg-6 clearfix border-top border-color-secondary"><div class="float-left pr-4 mb-6 mb-xl-0 col-12 col-lg-6 col-xl-3"><form class="f5" data-testid="survey-form" aria-live="polite"><h3 id="survey-title" class="f4 mb-3">Did you find what you needed?</h3><input type="text" class="d-none" name="survey-token" value=""/><div class="mb-2" role="radiogroup" aria-labelledby="survey-title"><input class="Survey_visuallyHidden__Xh_nl Survey_customRadio__aNqUl" id="survey-yes" type="radio" name="survey-vote" aria-label="Yes" value="Y"/><label class="btn mr-1" for="survey-yes"><svg aria-hidden="true" focusable="false" class="octicon octicon-thumbsup color-fg-muted" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="M8.347.631A.75.75 0 0 1 9.123.26l.238.04a3.25 3.25 0 0 1 2.591 4.098L11.494 6h.665a3.25 3.25 0 0 1 3.118 4.167l-1.135 3.859A2.751 2.751 0 0 1 11.503 16H6.586a3.75 3.75 0 0 1-2.184-.702A1.75 1.75 0 0 1 3 16H1.75A1.75 1.75 0 0 1 0 14.25v-6.5C0 6.784.784 6 1.75 6h3.417a.25.25 0 0 0 .217-.127ZM4.75 13.649l.396.33c.404.337.914.521 1.44.521h4.917a1.25 1.25 0 0 0 1.2-.897l1.135-3.859A1.75 1.75 0 0 0 12.159 7.5H10.5a.75.75 0 0 1-.721-.956l.731-2.558a1.75 1.75 0 0 0-1.127-2.14L6.69 6.611a1.75 1.75 0 0 1-1.523.889H4.75ZM3.25 7.5h-1.5a.25.25 0 0 0-.25.25v6.5c0 .138.112.25.25.25H3a.25.25 0 0 0 .25-.25Z"></path></svg> <!-- -->Yes</label><input class="Survey_visuallyHidden__Xh_nl Survey_customRadio__aNqUl" id="survey-no" type="radio" name="survey-vote" aria-label="No" value="N"/><label class="btn" for="survey-no"><svg aria-hidden="true" focusable="false" class="octicon octicon-thumbsdown color-fg-muted" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="M7.653 15.369a.75.75 0 0 1-.776.371l-.238-.04a3.25 3.25 0 0 1-2.591-4.099L4.506 10h-.665A3.25 3.25 0 0 1 .723 5.833l1.135-3.859A2.75 2.75 0 0 1 4.482 0H9.43c.78.003 1.538.25 2.168.702A1.752 1.752 0 0 1 12.989 0h1.272A1.75 1.75 0 0 1 16 1.75v6.5A1.75 1.75 0 0 1 14.25 10h-3.417a.25.25 0 0 0-.217.127ZM11.25 2.351l-.396-.33a2.248 2.248 0 0 0-1.44-.521H4.496a1.25 1.25 0 0 0-1.199.897L2.162 6.256A1.75 1.75 0 0 0 3.841 8.5H5.5a.75.75 0 0 1 .721.956l-.731 2.558a1.75 1.75 0 0 0 1.127 2.14L9.31 9.389a1.75 1.75 0 0 1 1.523-.889h.417Zm1.5 6.149h1.5a.25.25 0 0 0 .25-.25v-6.5a.25.25 0 0 0-.25-.25H13a.25.25 0 0 0-.25.25Z"></path></svg> <!-- -->No</label></div><a rel="" class="f6 text-underline" target="_blank" href="/en/site-policy/privacy-policies/github-privacy-statement">Privacy policy</a></form></div><div class="float-left pr-4 mb-6 mb-xl-0 col-12 col-lg-6 col-xl-4 offset-xl-1"><div class="f5 contribution"><h3 class="f4 mb-3">Help us make these docs great!</h3><p class="max-w-xs color-fg-muted mb-3">All GitHub docs are open source. See something that&#x27;s wrong or unclear? Submit a pull request.</p><a class="btn" href="https://github.com/github/docs/blob/main/content/webhooks/webhook-events-and-payloads.md"><svg aria-hidden="true" focusable="false" class="octicon octicon-git-pull-request octicon mr-1" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="M1.5 3.25a2.25 2.25 0 1 1 3 2.122v5.256a2.251 2.251 0 1 1-1.5 0V5.372A2.25 2.25 0 0 1 1.5 3.25Zm5.677-.177L9.573.677A.25.25 0 0 1 10 .854V2.5h1A2.5 2.5 0 0 1 13.5 5v5.628a2.251 2.251 0 1 1-1.5 0V5a1 1 0 0 0-1-1h-1v1.646a.25.25 0 0 1-.427.177L7.177 3.427a.25.25 0 0 1 0-.354ZM3.75 2.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm0 9.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm8.25.75a.75.75 0 1 0 1.5 0 .75.75 0 0 0-1.5 0Z"></path></svg>Make a contribution</a><p class="color-fg-muted f6 mt-2"><a class="text-underline" href="/contributing" target="_blank" rel="noopener">Learn how to contribute</a></p></div></div><div class="float-left pr-4 mb-6 mb-xl-0 col-12 col-lg-6 col-xl-3 offset-xl-1"><div><h3 class="mb-3 f4">Still need help?</h3><div class="mb-2"><a id="ask-community" href="https://github.com/orgs/community/discussions" class="text-underline"><svg aria-hidden="true" focusable="false" class="octicon octicon-people octicon mr-1" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="M2 5.5a3.5 3.5 0 1 1 5.898 2.549 5.508 5.508 0 0 1 3.034 4.084.75.75 0 1 1-1.482.235 4 4 0 0 0-7.9 0 .75.75 0 0 1-1.482-.236A5.507 5.507 0 0 1 3.102 8.05 3.493 3.493 0 0 1 2 5.5ZM11 4a3.001 3.001 0 0 1 2.22 5.018 5.01 5.01 0 0 1 2.56 3.012.749.749 0 0 1-.885.954.752.752 0 0 1-.549-.514 3.507 3.507 0 0 0-2.522-2.372.75.75 0 0 1-.574-.73v-.352a.75.75 0 0 1 .416-.672A1.5 1.5 0 0 0 11 5.5.75.75 0 0 1 11 4Zm-5.5-.5a2 2 0 1 0-.001 3.999A2 2 0 0 0 5.5 3.5Z"></path></svg>Ask the GitHub community</a></div><div><a id="support" href="https://support.github.com" class="text-underline"><svg aria-hidden="true" focusable="false" class="octicon octicon-comment-discussion octicon mr-1" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="M1.75 1h8.5c.966 0 1.75.784 1.75 1.75v5.5A1.75 1.75 0 0 1 10.25 10H7.061l-2.574 2.573A1.458 1.458 0 0 1 2 11.543V10h-.25A1.75 1.75 0 0 1 0 8.25v-5.5C0 1.784.784 1 1.75 1ZM1.5 2.75v5.5c0 .138.112.25.25.25h1a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h3.5a.25.25 0 0 0 .25-.25v-5.5a.25.25 0 0 0-.25-.25h-8.5a.25.25 0 0 0-.25.25Zm13 2a.25.25 0 0 0-.25-.25h-.5a.75.75 0 0 1 0-1.5h.5c.966 0 1.75.784 1.75 1.75v5.5A1.75 1.75 0 0 1 14.25 12H14v1.543a1.458 1.458 0 0 1-2.487 1.03L9.22 12.28a.749.749 0 0 1 .326-1.275.749.749 0 0 1 .734.215l2.22 2.22v-2.19a.75.75 0 0 1 .75-.75h1a.25.25 0 0 0 .25-.25Z"></path></svg>Contact support</a></div></div></div></div></section><section class="container-xl px-3 mt-6 pb-8 px-md-6 color-fg-muted"><h2 class="f4 mb-2 col-12">Legal</h2><ul class="d-flex flex-wrap list-style-none"><li class="mr-3">© <!-- -->2025<!-- --> GitHub, Inc.</li><li class="mr-3"><a class="text-underline" href="/en/site-policy/github-terms/github-terms-of-service">Terms</a></li><li class="mr-3"><a class="text-underline" href="/en/site-policy/privacy-policies/github-privacy-statement">Privacy</a></li><li class="mr-3"><a class="text-underline" href="https://www.githubstatus.com/">Status</a></li><li class="mr-3"><a class="text-underline" href="https://github.com/pricing">Pricing</a></li><li class="mr-3"><a class="text-underline" href="https://services.github.com">Expert services</a></li><li class="mr-3"><a class="text-underline" href="https://github.blog">Blog</a></li></ul></section><div role="tooltip" class="position-fixed bottom-0 mb-4 right-0 mr-4 z-1 ScrollButton_transition200__rLxBo ScrollButton_opacity0__vjKQD"><button class="ghd-scroll-to-top tooltipped tooltipped-n tooltipped-no-delay btn circle border-1 d-flex flex-items-center flex-justify-center ScrollButton_customFocus__L3FsX" style="width:40px;height:40px" aria-label="Scroll to top"><svg aria-hidden="true" focusable="false" class="octicon octicon-chevron-up" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" display="inline-block" overflow="visible" style="vertical-align:text-bottom"><path d="M3.22 10.53a.749.749 0 0 1 0-1.06l4.25-4.25a.749.749 0 0 1 1.06 0l4.25 4.25a.749.749 0 1 1-1.06 1.06L8 6.811 4.28 10.53a.749.749 0 0 1-1.06 0Z"></path></svg></button></div></footer></div></div><script type="application/json" id="__PRIMER_DATA_:R16:__">{"resolvedServerColorMode":"day"}</script></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"webhooks":[{"name":"branch_protection_configuration","actionTypes":["disabled","enabled"],"data":{"descriptionHtml":"\u003cp\u003eAll branch protections were disabled for a repository.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"\u003ca href=\"https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches\"\u003eAbout protected branches\u003c/a\u003e.\"\nFor information about using the APIs to manage branch protection rules, see \"\u003ca href=\"https://docs.github.com/graphql/reference/objects#branchprotectionrule\"\u003eBranch protection rule\u003c/a\u003e\" in the GraphQL documentation or \"\u003ca href=\"https://docs.github.com/rest/branches/branch-protection\"\u003eBranch protection\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["disabled"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"disabled","category":"branch_protection_configuration"}},{"name":"branch_protection_rule","actionTypes":["created","deleted","edited"],"data":{"descriptionHtml":"\u003cp\u003eA branch protection rule was created.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to branch protection rules. For more information, see \"\u003ca href=\"https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches\"\u003eAbout protected branches\u003c/a\u003e.\" For information about the APIs to manage branch protection rules, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#branchprotectionrule\"\u003ethe GraphQL documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/branches/branch-protection\"\u003eBranch protection\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["created"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"rule","in":"body","description":"\u003cp\u003eThe branch protection rule. Includes a \u003ccode\u003ename\u003c/code\u003e and all the \u003ca href=\"https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings\"\u003ebranch protection settings\u003c/a\u003e applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of \u003ccode\u003eoff\u003c/code\u003e, \u003ccode\u003enon_admins\u003c/code\u003e, or \u003ccode\u003eeveryone\u003c/code\u003e. Actor and build lists are arrays of strings.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"created","category":"branch_protection_rule"}},{"name":"check_run","actionTypes":["completed","created","requested_action","rerequested"],"data":{"descriptionHtml":"\u003cp\u003eA check run was completed, and a conclusion is available.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a check run. For information about check runs, see \"\u003ca href=\"https://docs.github.com/rest/guides/getting-started-with-the-checks-api\"\u003eGetting started with the Checks API\u003c/a\u003e.\" For information about the APIs to manage check runs, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#checkrun\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/checks/runs\"\u003eCheck Runs\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eFor activity relating to check suites, use the \u003ccode\u003echeck-suite\u003c/code\u003e event.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the \u003ccode\u003ererequested\u003c/code\u003e and \u003ccode\u003erequested_action\u003c/code\u003e event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\u003c/p\u003e\n\u003cp\u003eRepository and organization webhooks only receive payloads for the \u003ccode\u003ecreated\u003c/code\u003e and \u003ccode\u003ecompleted\u003c/code\u003e event types in repositories.\u003c/p\u003e\n\u003cdiv class=\"ghd-alert ghd-alert-accent\"\u003e\u003cp class=\"ghd-alert-title\"\u003e\u003csvg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden\u003e\u003cpath d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\u003e\u003c/path\u003e\u003c/svg\u003eNote\u003c/p\u003e\n\u003cp\u003e\nThe API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty \u003ccode\u003epull_requests\u003c/code\u003e array and a \u003ccode\u003enull\u003c/code\u003e value for \u003ccode\u003ehead_branch\u003c/code\u003e.\u003c/p\u003e\n\u003c/div\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","enum":["completed"],"childParamsGroups":[]},{"type":"object","name":"check_run","in":"body","description":"\u003cp\u003eA check performed on the code of a given code change\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"completed","category":"check_run"}},{"name":"check_suite","actionTypes":["completed","requested","rerequested"],"data":{"descriptionHtml":"\u003cp\u003eAll check runs in a check suite have completed, and a conclusion is available.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a check suite. For information about check suites, see \"\u003ca href=\"https://docs.github.com/rest/guides/getting-started-with-the-checks-api\"\u003eGetting started with the Checks API\u003c/a\u003e.\" For information about the APIs to manage check suites, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#checksuite\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/checks/suites\"\u003eCheck Suites\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eFor activity relating to check runs, use the \u003ccode\u003echeck_run\u003c/code\u003e event.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the \u003ccode\u003erequested\u003c/code\u003e and \u003ccode\u003ererequested\u003c/code\u003e event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\u003c/p\u003e\n\u003cp\u003eRepository and organization webhooks only receive payloads for the \u003ccode\u003ecompleted\u003c/code\u003e event types in repositories.\u003c/p\u003e\n\u003cdiv class=\"ghd-alert ghd-alert-accent\"\u003e\u003cp class=\"ghd-alert-title\"\u003e\u003csvg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden\u003e\u003cpath d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\u003e\u003c/path\u003e\u003c/svg\u003eNote\u003c/p\u003e\n\u003cp\u003e\nThe API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty \u003ccode\u003epull_requests\u003c/code\u003e array and a \u003ccode\u003enull\u003c/code\u003e value for \u003ccode\u003ehead_branch\u003c/code\u003e.\u003c/p\u003e\n\u003c/div\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["completed"],"childParamsGroups":[]},{"type":"object","name":"check_suite","in":"body","description":"\u003cp\u003eThe \u003ca href=\"https://docs.github.com/rest/checks/suites#get-a-check-suite\"\u003echeck_suite\u003c/a\u003e.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"completed","category":"check_suite"}},{"name":"code_scanning_alert","actionTypes":["appeared_in_branch","closed_by_user","created","fixed","reopened","reopened_by_user"],"data":{"descriptionHtml":"\u003cp\u003eA previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"\u003ca href=\"https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning\"\u003eAbout code scanning\u003c/a\u003e\" and \"\u003ca href=\"https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts\"\u003eAbout code scanning alerts\u003c/a\u003e.\" For information about the API to manage code scanning, see \"\u003ca href=\"https://docs.github.com/rest/code-scanning\"\u003eCode scanning\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["appeared_in_branch"],"childParamsGroups":[]},{"type":"object","name":"alert","in":"body","description":"\u003cp\u003eThe code scanning alert involved in the event.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"string","name":"commit_oid","in":"body","description":"\u003cp\u003eThe commit SHA of the code scanning alert. When the action is \u003ccode\u003ereopened_by_user\u003c/code\u003e or \u003ccode\u003eclosed_by_user\u003c/code\u003e, the event was triggered by the \u003ccode\u003esender\u003c/code\u003e and this value will be empty.\u003c/p\u003e","isRequired":true},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"string","name":"ref","in":"body","description":"\u003cp\u003eThe Git reference of the code scanning alert. When the action is \u003ccode\u003ereopened_by_user\u003c/code\u003e or \u003ccode\u003eclosed_by_user\u003c/code\u003e, the event was triggered by the \u003ccode\u003esender\u003c/code\u003e and this value will be empty.\u003c/p\u003e","isRequired":true},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"appeared_in_branch","category":"code_scanning_alert"}},{"name":"commit_comment","actionTypes":["created"],"data":{"descriptionHtml":"\u003cp\u003eSomeone commented on a commit.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to commit comments. For more information about commit comments, see \"\u003ca href=\"https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request\"\u003eCommenting on a pull request\u003c/a\u003e.\" For information about the APIs to manage commit comments, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#commitcomment\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/commits/comments\"\u003eCommit comments\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eFor activity relating to comments on pull request reviews, use the \u003ccode\u003epull_request_review_comment\u003c/code\u003e event. For activity relating to issue comments, use the \u003ccode\u003eissue_comment\u003c/code\u003e event. For activity relating to discussion comments, use the \u003ccode\u003ediscussion_comment\u003c/code\u003e event.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"\u003cp\u003eThe action performed. Can be \u003ccode\u003ecreated\u003c/code\u003e.\u003c/p\u003e","isRequired":true,"enum":["created"],"childParamsGroups":[]},{"type":"object","name":"comment","in":"body","description":"\u003cp\u003eThe \u003ca href=\"$%7BexternalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl%7D/rest/commits/comments#get-a-commit-comment\"\u003ecommit comment\u003c/a\u003e resource.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"created","category":"commit_comment"}},{"name":"create","actionTypes":["default"],"data":{"descriptionHtml":"","summaryHtml":"\u003cp\u003eThis event occurs when a Git branch or tag is created.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eNotes\u003c/strong\u003e:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eThis event will not occur when more than three tags are created at once.\u003c/li\u003e\n\u003cli\u003ePayloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.\u003c/li\u003e\n\u003c/ul\u003e","bodyParameters":[{"type":"string or null","name":"description","in":"body","description":"\u003cp\u003eThe repository's current description.\u003c/p\u003e","isRequired":true},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"string","name":"master_branch","in":"body","description":"\u003cp\u003eThe name of the repository's default branch (usually \u003ccode\u003emain\u003c/code\u003e).\u003c/p\u003e","isRequired":true},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"string","name":"pusher_type","in":"body","description":"\u003cp\u003eThe pusher type for the event. Can be either \u003ccode\u003euser\u003c/code\u003e or a deploy key.\u003c/p\u003e","isRequired":true},{"type":"string","name":"ref","in":"body","description":"\u003cp\u003eThe \u003ca href=\"https://docs.github.com/rest/git/refs#get-a-reference\"\u003e\u003ccode\u003egit ref\u003c/code\u003e\u003c/a\u003e resource.\u003c/p\u003e","isRequired":true},{"type":"string","name":"ref_type","in":"body","description":"\u003cp\u003eThe type of Git ref object created in the repository.\u003c/p\u003e","isRequired":true,"enum":["tag","branch"]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"default","category":"create"}},{"name":"custom_property","actionTypes":["created","deleted","updated"],"data":{"descriptionHtml":"\u003cp\u003eA new custom property was created.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a custom property.\u003c/p\u003e\n\u003cp\u003eFor more information, see \"\u003ca href=\"https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization\"\u003eManaging custom properties for repositories in your organization\u003c/a\u003e\". For information about the APIs to manage custom properties, see \"\u003ca href=\"https://docs.github.com/rest/orgs/custom-properties\"\u003eCustom properties\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["created"],"childParamsGroups":[]},{"type":"object","name":"definition","in":"body","description":"\u003cp\u003eCustom property defined on an organization\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","childParamsGroups":[]}],"availability":["business","organization","app"],"action":"created","category":"custom_property"}},{"name":"custom_property_values","actionTypes":["updated"],"data":{"descriptionHtml":"\u003cp\u003eThe custom property values of a repository were updated.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to custom property values for a repository.\u003c/p\u003e\n\u003cp\u003eFor more information, see \"\u003ca href=\"https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization\"\u003eManaging custom properties for repositories in your organization\u003c/a\u003e\". For information about the APIs to manage custom properties for a repository, see \"\u003ca href=\"https://docs.github.com/rest/repos/custom-properties\"\u003eCustom properties\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["updated"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","childParamsGroups":[]},{"type":"array of objects","name":"new_property_values","in":"body","description":"\u003cp\u003eThe new custom property values for the repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"array of objects","name":"old_property_values","in":"body","description":"\u003cp\u003eThe old custom property values for the repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"updated","category":"custom_property_values"}},{"name":"delete","actionTypes":["default"],"data":{"descriptionHtml":"","summaryHtml":"\u003cp\u003eThis event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the \u003ca href=\"#push\"\u003e\u003ccode\u003epush\u003c/code\u003e\u003c/a\u003e webhook event.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\u003c/p\u003e\n\u003cdiv class=\"ghd-alert ghd-alert-accent\"\u003e\u003cp class=\"ghd-alert-title\"\u003e\u003csvg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden\u003e\u003cpath d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\u003e\u003c/path\u003e\u003c/svg\u003eNote\u003c/p\u003e\n\u003cp\u003e\nThis event will not occur when more than three tags are deleted at once.\u003c/p\u003e\n\u003c/div\u003e","bodyParameters":[{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"string","name":"pusher_type","in":"body","description":"\u003cp\u003eThe pusher type for the event. Can be either \u003ccode\u003euser\u003c/code\u003e or a deploy key.\u003c/p\u003e","isRequired":true},{"type":"string","name":"ref","in":"body","description":"\u003cp\u003eThe \u003ca href=\"https://docs.github.com/rest/git/refs#get-a-reference\"\u003e\u003ccode\u003egit ref\u003c/code\u003e\u003c/a\u003e resource.\u003c/p\u003e","isRequired":true},{"type":"string","name":"ref_type","in":"body","description":"\u003cp\u003eThe type of Git ref object deleted in the repository.\u003c/p\u003e","isRequired":true,"enum":["tag","branch"]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"default","category":"delete"}},{"name":"dependabot_alert","actionTypes":["auto_dismissed","auto_reopened","created","dismissed","fixed","reintroduced","reopened"],"data":{"descriptionHtml":"\u003cp\u003eA Dependabot alert was automatically closed by a Dependabot auto-triage rule.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to Dependabot alerts.\u003c/p\u003e\n\u003cp\u003eFor more information about Dependabot alerts, see \"\u003ca href=\"https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts\"\u003eAbout Dependabot alerts\u003c/a\u003e.\" For information about the API to manage Dependabot alerts, see \"\u003ca href=\"https://docs.github.com/rest/dependabot/alerts\"\u003eDependabot alerts\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\u003c/p\u003e\n\u003cdiv class=\"ghd-alert ghd-alert-accent\"\u003e\u003cp class=\"ghd-alert-title\"\u003e\u003csvg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden\u003e\u003cpath d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\u003e\u003c/path\u003e\u003c/svg\u003eNote\u003c/p\u003e\n\u003cp\u003e\nWebhook events for Dependabot alerts are currently in public preview and subject to change.\u003c/p\u003e\n\u003c/div\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["auto_dismissed"],"childParamsGroups":[]},{"type":"object","name":"alert","in":"body","description":"\u003cp\u003eA Dependabot alert.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"auto_dismissed","category":"dependabot_alert"}},{"name":"deploy_key","actionTypes":["created","deleted"],"data":{"descriptionHtml":"\u003cp\u003eA deploy key was created.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to deploy keys. For more information, see \"\u003ca href=\"https://docs.github.com/developers/overview/managing-deploy-keys\"\u003eManaging deploy keys\u003c/a\u003e.\" For information about the APIs to manage deploy keys, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#deploykey\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/deploy-keys\"\u003eDeploy keys\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["created"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"key","in":"body","description":"\u003cp\u003eThe \u003ca href=\"https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key\"\u003e\u003ccode\u003edeploy key\u003c/code\u003e\u003c/a\u003e resource.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"created","category":"deploy_key"}},{"name":"deployment","actionTypes":["created"],"data":{"descriptionHtml":"\u003cp\u003eA deployment was created.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to deployments. For more information, see \"\u003ca href=\"https://docs.github.com/actions/deployment/about-deployments\"\u003eAbout deployments\u003c/a\u003e.\" For information about the APIs to manage deployments, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#deployment\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/deployments/deployments\"\u003eDeployments\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eFor activity relating to deployment status, use the \u003ccode\u003edeployment_status\u003c/code\u003e event.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["created"],"childParamsGroups":[]},{"type":"object","name":"deployment","in":"body","description":"\u003cp\u003eThe \u003ca href=\"https://docs.github.com/rest/deployments/deployments#list-deployments\"\u003edeployment\u003c/a\u003e.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object or null","name":"workflow","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object or null","name":"workflow_run","in":"body","description":"","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"created","category":"deployment"}},{"name":"deployment_protection_rule","actionTypes":["requested"],"data":{"descriptionHtml":"\u003cp\u003eA deployment protection rule was requested for an environment.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to deployment protection rules. For more information, see \"\u003ca href=\"https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules\"\u003eUsing environments for deployment\u003c/a\u003e.\" For information about the API to manage deployment protection rules, see \u003ca href=\"https://docs.github.com/rest/deployments/environments\"\u003ethe REST API documentation\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","enum":["requested"],"childParamsGroups":[]},{"type":"string","name":"environment","in":"body","description":"\u003cp\u003eThe name of the environment that has the deployment protection rule.\u003c/p\u003e"},{"type":"string","name":"event","in":"body","description":"\u003cp\u003eThe event that triggered the deployment protection rule.\u003c/p\u003e"},{"type":"string","name":"deployment_callback_url","in":"body","description":"\u003cp\u003eThe URL to review the deployment protection rule.\u003c/p\u003e"},{"type":"object","name":"deployment","in":"body","description":"\u003cp\u003eA request for a specific ref(branch,sha,tag) to be deployed\u003c/p\u003e","childParamsGroups":[]},{"type":"array of objects","name":"pull_requests","in":"body","description":"","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","childParamsGroups":[]}],"availability":["app"],"action":"requested","category":"deployment_protection_rule"}},{"name":"deployment_review","actionTypes":["approved","rejected","requested"],"data":{"descriptionHtml":"\u003cp\u003eA deployment review was approved.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to deployment reviews. For more information, see \"\u003ca href=\"https://docs.github.com/actions/deployment/about-deployments\"\u003eAbout deployments\u003c/a\u003e.\" For information about the APIs to manage deployments, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#deployment\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/deployments/deployments\"\u003eDeployments\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eFor activity relating to deployment creation or deployment status, use the \u003ccode\u003edeployment\u003c/code\u003e or \u003ccode\u003edeployment_status\u003c/code\u003e event.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["approved"],"childParamsGroups":[]},{"type":"object","name":"approver","in":"body","description":"","childParamsGroups":[]},{"type":"string","name":"comment","in":"body","description":""},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"array of objects","name":"reviewers","in":"body","description":"","childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"string","name":"since","in":"body","description":"","isRequired":true},{"type":"object","name":"workflow_job_run","in":"body","description":"","childParamsGroups":[]},{"type":"array of objects","name":"workflow_job_runs","in":"body","description":"","childParamsGroups":[]},{"type":"object or null","name":"workflow_run","in":"body","description":"","isRequired":true,"childParamsGroups":[]}],"availability":["app"],"action":"approved","category":"deployment_review"}},{"name":"deployment_status","actionTypes":["created"],"data":{"descriptionHtml":"\u003cp\u003eA new deployment status was created.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to deployment statuses. For more information, see \"\u003ca href=\"https://docs.github.com/actions/deployment/about-deployments\"\u003eAbout deployments\u003c/a\u003e.\" For information about the APIs to manage deployments, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#deployment\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/deployments/deployments\"\u003eDeployments\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eFor activity relating to deployment creation, use the \u003ccode\u003edeployment\u003c/code\u003e event.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\u003c/p\u003e\n\u003cdiv class=\"ghd-alert ghd-alert-accent\"\u003e\u003cp class=\"ghd-alert-title\"\u003e\u003csvg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden\u003e\u003cpath d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\u003e\u003c/path\u003e\u003c/svg\u003eNote\u003c/p\u003e\n\u003cp\u003e\nA webhook event is not fired for deployment statuses with an \u003ccode\u003einactive\u003c/code\u003e state.\u003c/p\u003e\n\u003c/div\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["created"],"childParamsGroups":[]},{"type":"object or null","name":"check_run","in":"body","description":"","childParamsGroups":[]},{"type":"object","name":"deployment","in":"body","description":"\u003cp\u003eThe \u003ca href=\"https://docs.github.com/rest/deployments/deployments#list-deployments\"\u003edeployment\u003c/a\u003e.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"deployment_status","in":"body","description":"\u003cp\u003eThe \u003ca href=\"https://docs.github.com/rest/deployments/statuses#list-deployment-statuses\"\u003edeployment status\u003c/a\u003e.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object or null","name":"workflow","in":"body","description":"","childParamsGroups":[]},{"type":"object or null","name":"workflow_run","in":"body","description":"","childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"created","category":"deployment_status"}},{"name":"discussion","actionTypes":["answered","category_changed","closed","created","deleted","edited","labeled","locked","pinned","reopened","transferred","unanswered","unlabeled","unlocked","unpinned"],"data":{"descriptionHtml":"\u003cp\u003eA comment on the discussion was marked as the answer.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"\u003ca href=\"https://docs.github.com/discussions\"\u003eGitHub Discussions\u003c/a\u003e.\" For information about the API to manage discussions, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#discussion\"\u003ethe GraphQL documentation\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eFor activity relating to a comment on a discussion, use the \u003ccode\u003ediscussion_comment\u003c/code\u003e event.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\u003c/p\u003e\n\u003cdiv class=\"ghd-alert ghd-alert-accent\"\u003e\u003cp class=\"ghd-alert-title\"\u003e\u003csvg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden\u003e\u003cpath d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\u003e\u003c/path\u003e\u003c/svg\u003eNote\u003c/p\u003e\n\u003cp\u003e\nWebhook events for GitHub Discussions are currently in public preview and subject to change.\u003c/p\u003e\n\u003c/div\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["answered"],"childParamsGroups":[]},{"type":"object","name":"answer","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"discussion","in":"body","description":"\u003cp\u003eA Discussion in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"answered","category":"discussion"}},{"name":"discussion_comment","actionTypes":["created","deleted","edited"],"data":{"descriptionHtml":"\u003cp\u003eA comment on a discussion was created.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"\u003ca href=\"https://docs.github.com/discussions\"\u003eGitHub Discussions\u003c/a\u003e.\" For information about the API to manage discussions, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#discussion\"\u003ethe GraphQL documentation\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eFor activity relating to a discussion as opposed to comments on a discussion, use the \u003ccode\u003ediscussion\u003c/code\u003e event.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\u003c/p\u003e\n\u003cdiv class=\"ghd-alert ghd-alert-accent\"\u003e\u003cp class=\"ghd-alert-title\"\u003e\u003csvg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden\u003e\u003cpath d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\u003e\u003c/path\u003e\u003c/svg\u003eNote\u003c/p\u003e\n\u003cp\u003e\nWebhook events for GitHub Discussions are currently in public preview and subject to change.\u003c/p\u003e\n\u003c/div\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["created"],"childParamsGroups":[]},{"type":"object","name":"comment","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"discussion","in":"body","description":"\u003cp\u003eA Discussion in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"created","category":"discussion_comment"}},{"name":"fork","actionTypes":["default"],"data":{"descriptionHtml":"","summaryHtml":"\u003cp\u003eThis event occurs when someone forks a repository. For more information, see \"\u003ca href=\"https://docs.github.com/get-started/quickstart/fork-a-repo\"\u003eFork a repo\u003c/a\u003e.\" For information about the API to manage forks, see \"\u003ca href=\"https://docs.github.com/rest/repos/forks\"\u003eForks\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"forkee","in":"body","description":"\u003cp\u003eThe created \u003ca href=\"https://docs.github.com/rest/repos/repos#get-a-repository\"\u003e\u003ccode\u003erepository\u003c/code\u003e\u003c/a\u003e resource.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["business","repository","organization","app"],"action":"default","category":"fork"}},{"name":"github_app_authorization","actionTypes":["revoked"],"data":{"descriptionHtml":"\u003cp\u003eSomeone revoked their authorization of a GitHub App.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when a user revokes their authorization of a GitHub App. For more information, see \"\u003ca href=\"https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps\"\u003eAbout apps\u003c/a\u003e.\" For information about the API to manage GitHub Apps, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#app\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/apps\"\u003eApps\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eA GitHub App receives this webhook by default and cannot unsubscribe from this event.\u003c/p\u003e\n\u003cp\u003eAnyone can revoke their authorization of a GitHub App from their \u003ca href=\"https://github.com/settings/apps/authorizations\"\u003eGitHub account settings page\u003c/a\u003e. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the \u003ccode\u003e401 Bad Credentials\u003c/code\u003e error. For details about requests with a user access token, which require GitHub App authorization, see \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user\"\u003eAuthenticating with a GitHub App on behalf of a user\u003c/a\u003e.\"\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["revoked"],"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["app"],"action":"revoked","category":"github_app_authorization"}},{"name":"gollum","actionTypes":["default"],"data":{"descriptionHtml":"","summaryHtml":"\u003cp\u003eThis event occurs when someone creates or updates a wiki page. For more information, see \"\u003ca href=\"https://docs.github.com/communities/documenting-your-project-with-wikis/about-wikis\"\u003eAbout wikis\u003c/a\u003e.\"\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"array of objects","name":"pages","in":"body","description":"\u003cp\u003eThe pages that were updated.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"default","category":"gollum"}},{"name":"installation","actionTypes":["created","deleted","new_permissions_accepted","suspend","unsuspend"],"data":{"descriptionHtml":"\u003cp\u003eSomeone installed a GitHub App on a user or organization account.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\u003c/p\u003e\n\u003cp\u003eFor more information about GitHub Apps, see \"\u003ca href=\"https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps\"\u003eAbout apps\u003c/a\u003e.\" For information about the APIs to manage GitHub Apps, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#app\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/apps\"\u003eApps\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["created"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eInstallation\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"array of objects","name":"repositories","in":"body","description":"\u003cp\u003eAn array of repository objects that the installation can access.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"object or null","name":"requester","in":"body","description":"","childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["app"],"action":"created","category":"installation"}},{"name":"installation_repositories","actionTypes":["added","removed"],"data":{"descriptionHtml":"\u003cp\u003eA GitHub App installation was granted access to one or more repositories.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\u003c/p\u003e\n\u003cp\u003eFor more information about GitHub Apps, see \"\u003ca href=\"https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps\"\u003eAbout apps\u003c/a\u003e.\" For information about the APIs to manage GitHub Apps, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#app\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/apps\"\u003eApps\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["added"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eInstallation\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"array of objects","name":"repositories_added","in":"body","description":"\u003cp\u003eAn array of repository objects, which were added to the installation.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"array of objects","name":"repositories_removed","in":"body","description":"\u003cp\u003eAn array of repository objects, which were removed from the installation.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"string","name":"repository_selection","in":"body","description":"\u003cp\u003eDescribe whether all repositories have been selected or there's a selection involved\u003c/p\u003e","isRequired":true,"enum":["all","selected"]},{"type":"object or null","name":"requester","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["app"],"action":"added","category":"installation_repositories"}},{"name":"installation_target","actionTypes":["renamed"],"data":{"descriptionHtml":"\u003cp\u003eSomebody renamed the user or organization account that a GitHub App is installed on.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"\u003ca href=\"https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps\"\u003eAbout apps\u003c/a\u003e.\" For information about the APIs to manage GitHub Apps, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#app\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/apps\"\u003eApps\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e","bodyParameters":[{"type":"object","name":"account","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["renamed"],"childParamsGroups":[]},{"type":"object","name":"changes","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","childParamsGroups":[]},{"type":"string","name":"target_type","in":"body","description":"","isRequired":true}],"availability":["app"],"action":"renamed","category":"installation_target"}},{"name":"issue_comment","actionTypes":["created","deleted","edited"],"data":{"descriptionHtml":"\u003cp\u003eA comment on an issue or pull request was created.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"\u003ca href=\"https://docs.github.com/issues/tracking-your-work-with-issues/about-issues\"\u003eAbout issues\u003c/a\u003e\" and \"\u003ca href=\"https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests\"\u003eAbout pull requests\u003c/a\u003e.\" For information about the APIs to manage issue comments, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#issuecomment\"\u003ethe GraphQL documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/issues/comments\"\u003eIssue comments\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eFor activity relating to an issue as opposed to comments on an issue, use the \u003ccode\u003eissue\u003c/code\u003e event. For activity related to pull request reviews or pull request review comments, use the \u003ccode\u003epull_request_review\u003c/code\u003e or \u003ccode\u003epull_request_review_comment\u003c/code\u003e events. For more information about the different types of pull request comments, see \"\u003ca href=\"https://docs.github.com/rest/guides/working-with-comments\"\u003eWorking with comments\u003c/a\u003e.\"\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["created"],"childParamsGroups":[]},{"type":"object","name":"comment","in":"body","description":"\u003cp\u003eThe \u003ca href=\"https://docs.github.com/rest/issues/comments#get-an-issue-comment\"\u003ecomment\u003c/a\u003e itself.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"issue","in":"body","description":"\u003cp\u003eThe \u003ca href=\"https://docs.github.com/rest/issues/issues#get-an-issue\"\u003eissue\u003c/a\u003e the comment belongs to.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"created","category":"issue_comment"}},{"name":"issues","actionTypes":["assigned","closed","deleted","demilestoned","edited","labeled","locked","milestoned","opened","pinned","reopened","transferred","unassigned","unlabeled","unlocked","unpinned"],"data":{"descriptionHtml":"\u003cp\u003eAn issue was assigned to a user.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to an issue. For more information about issues, see \"\u003ca href=\"https://docs.github.com/issues/tracking-your-work-with-issues/about-issues\"\u003eAbout issues\u003c/a\u003e.\" For information about the APIs to manage issues, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#issue\"\u003ethe GraphQL documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/issues\"\u003eIssues\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eFor activity relating to a comment on an issue, use the \u003ccode\u003eissue_comment\u003c/code\u003e event.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"\u003cp\u003eThe action that was performed.\u003c/p\u003e","isRequired":true,"enum":["assigned"],"childParamsGroups":[]},{"type":"object or null","name":"assignee","in":"body","description":"","childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"issue","in":"body","description":"\u003cp\u003eThe \u003ca href=\"https://docs.github.com/rest/issues/issues#get-an-issue\"\u003eissue\u003c/a\u003e itself.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"assigned","category":"issues"}},{"name":"label","actionTypes":["created","deleted","edited"],"data":{"descriptionHtml":"\u003cp\u003eA label was created.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to labels. For more information, see \"\u003ca href=\"https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels\"\u003eManaging labels\u003c/a\u003e.\" For information about the APIs to manage labels, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#label\"\u003ethe GraphQL documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/issues/labels\"\u003eLabels\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the \u003ccode\u003elabeled\u003c/code\u003e or \u003ccode\u003eunlabeled\u003c/code\u003e action type for the \u003ccode\u003eissues\u003c/code\u003e, \u003ccode\u003epull_request\u003c/code\u003e, or \u003ccode\u003ediscussion\u003c/code\u003e events instead.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["created"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"label","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"created","category":"label"}},{"name":"marketplace_purchase","actionTypes":["cancelled","changed","pending_change","pending_change_cancelled","purchased"],"data":{"descriptionHtml":"\u003cp\u003eSomeone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"\u003ca href=\"https://docs.github.com/marketplace\"\u003eGitHub Marketplace\u003c/a\u003e.\" For information about the APIs to manage GitHub Marketplace listings, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#marketplacelisting\"\u003ethe GraphQL documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/apps/marketplace\"\u003eGitHub Marketplace\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["cancelled"],"childParamsGroups":[]},{"type":"string","name":"effective_date","in":"body","description":"","isRequired":true},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"marketplace_purchase","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"previous_marketplace_purchase","in":"body","description":"","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["marketplace"],"action":"cancelled","category":"marketplace_purchase"}},{"name":"member","actionTypes":["added","edited","removed"],"data":{"descriptionHtml":"\u003cp\u003eA GitHub user accepted an invitation to a repository.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to collaborators in a repository. For more information, see \"\u003ca href=\"https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization\"\u003eAdding outside collaborators to repositories in your organization\u003c/a\u003e.\" For more information about the API to manage repository collaborators, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/collaborators/collaborators\"\u003eCollaborators\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["added"],"childParamsGroups":[]},{"type":"object","name":"changes","in":"body","description":"","childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object or null","name":"member","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["business","repository","organization","app"],"action":"added","category":"member"}},{"name":"membership","actionTypes":["added","removed"],"data":{"descriptionHtml":"\u003cp\u003eAn organization member was added to a team.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to team membership. For more information, see \"\u003ca href=\"https://docs.github.com/organizations/organizing-members-into-teams/about-teams\"\u003eAbout teams\u003c/a\u003e.\" For more information about the APIs to manage team memberships, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#team\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/teams/members\"\u003eTeam members\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["added"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object or null","name":"member","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"string","name":"scope","in":"body","description":"\u003cp\u003eThe scope of the membership. Currently, can only be \u003ccode\u003eteam\u003c/code\u003e.\u003c/p\u003e","isRequired":true,"enum":["team"]},{"type":"object or null","name":"sender","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"team","in":"body","description":"\u003cp\u003eGroups of organization members that gives permissions on specified repositories.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["organization","business","app"],"action":"added","category":"membership"}},{"name":"merge_group","actionTypes":["checks_requested","destroyed"],"data":{"descriptionHtml":"\u003cp\u003eStatus checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\u003c/p\u003e\n\u003cp\u003eWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"\u003ca href=\"https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue\"\u003eManaging a merge queue\u003c/a\u003e.\"\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["checks_requested"],"childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"merge_group","in":"body","description":"\u003cp\u003eA group of pull requests that the merge queue has grouped together to be merged.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","childParamsGroups":[]}],"availability":["app"],"action":"checks_requested","category":"merge_group"}},{"name":"meta","actionTypes":["deleted"],"data":{"descriptionHtml":"\u003cp\u003eThe webhook was deleted.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a webhook itself.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["deleted"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"hook","in":"body","description":"\u003cp\u003eThe modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"integer","name":"hook_id","in":"body","description":"\u003cp\u003eThe id of the modified webhook.\u003c/p\u003e","isRequired":true},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","childParamsGroups":[]}],"availability":["marketplace","business","repository","organization","app"],"action":"deleted","category":"meta"}},{"name":"milestone","actionTypes":["closed","created","deleted","edited","opened"],"data":{"descriptionHtml":"\u003cp\u003eA milestone was closed.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to milestones. For more information, see \"\u003ca href=\"https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones\"\u003eAbout milestones\u003c/a\u003e.\" For information about the APIs to manage milestones, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#milestone\"\u003ethe GraphQL documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/issues/milestones\"\u003eMilestones\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the \u003ccode\u003emilestoned\u003c/code\u003e or \u003ccode\u003edemilestoned\u003c/code\u003e action type for the \u003ccode\u003eissues\u003c/code\u003e or \u003ccode\u003epull_request\u003c/code\u003e events instead.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["closed"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"milestone","in":"body","description":"\u003cp\u003eA collection of related issues and pull requests.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"closed","category":"milestone"}},{"name":"org_block","actionTypes":["blocked","unblocked"],"data":{"descriptionHtml":"\u003cp\u003eA user was blocked from the organization.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"\u003ca href=\"https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization\"\u003eBlocking a user from your organization\u003c/a\u003e.\" For information about the APIs to manage blocked users, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#userblockedevent\"\u003ethe GraphQL documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/orgs/blocking\"\u003eBlocking users\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eIf you want to receive an event when members are added or removed from an organization, use the \u003ccode\u003eorganization\u003c/code\u003e event instead.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["blocked"],"childParamsGroups":[]},{"type":"object or null","name":"blocked_user","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["organization","business","app"],"action":"blocked","category":"org_block"}},{"name":"organization","actionTypes":["deleted","member_added","member_invited","member_removed","renamed"],"data":{"descriptionHtml":"\u003cp\u003eAn organization was deleted.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to an organization and its members. For more information, see \"\u003ca href=\"https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations\"\u003eAbout organizations\u003c/a\u003e.\" For information about the APIs to manage organizations, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#organization\"\u003ethe GraphQL documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/orgs\"\u003eOrganizations\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the \u003ccode\u003eorg_block\u003c/code\u003e event instead.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["deleted"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"membership","in":"body","description":"\u003cp\u003eThe membership between the user and the organization. Not present when the action is \u003ccode\u003emember_invited\u003c/code\u003e.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["organization","business","app"],"action":"deleted","category":"organization"}},{"name":"package","actionTypes":["published","updated"],"data":{"descriptionHtml":"\u003cp\u003eA package was published to a registry.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to GitHub Packages. For more information, see \"\u003ca href=\"https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages\"\u003eIntroduction to GitHub Packages\u003c/a\u003e.\" For information about the APIs to manage GitHub Packages, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#package\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/packages\"\u003ePackages\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["published"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"package","in":"body","description":"\u003cp\u003eInformation about the package.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"published","category":"package"}},{"name":"page_build","actionTypes":["default"],"data":{"descriptionHtml":"","summaryHtml":"\u003cp\u003eThis event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"\u003ca href=\"https://docs.github.com/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site\"\u003eConfiguring a publishing source for your GitHub Pages site\u003c/a\u003e.\" For information about the API to manage GitHub Pages, see \"\u003ca href=\"https://docs.github.com/rest/pages\"\u003ePages\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"object","name":"build","in":"body","description":"\u003cp\u003eThe \u003ca href=\"https://docs.github.com/rest/pages/pages#list-github-pages-builds\"\u003eList GitHub Pages builds\u003c/a\u003e itself.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"integer","name":"id","in":"body","description":"","isRequired":true},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"default","category":"page_build"}},{"name":"personal_access_token_request","actionTypes":["approved","cancelled","created","denied"],"data":{"descriptionHtml":"\u003cp\u003eA fine-grained personal access token request was approved.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"\u003ca href=\"https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token\"\u003eCreating a personal access token\u003c/a\u003e.\"\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\u003c/p\u003e\n\u003cdiv class=\"ghd-alert ghd-alert-accent\"\u003e\u003cp class=\"ghd-alert-title\"\u003e\u003csvg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden\u003e\u003cpath d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\u003e\u003c/path\u003e\u003c/svg\u003eNote\u003c/p\u003e\n\u003cp\u003e\nFine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.\u003c/p\u003e\n\u003c/div\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["approved"],"childParamsGroups":[]},{"type":"object","name":"personal_access_token_request","in":"body","description":"\u003cp\u003eDetails of a Personal Access Token Request.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["app"],"action":"approved","category":"personal_access_token_request"}},{"name":"ping","actionTypes":["default"],"data":{"descriptionHtml":"","summaryHtml":"\u003cp\u003eThis event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.\u003c/p\u003e","bodyParameters":[{"type":"object","name":"hook","in":"body","description":"\u003cp\u003eThe webhook that is being pinged\u003c/p\u003e","childParamsGroups":[]},{"type":"integer","name":"hook_id","in":"body","description":"\u003cp\u003eThe ID of the webhook that triggered the ping.\u003c/p\u003e"},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","childParamsGroups":[]},{"type":"string","name":"zen","in":"body","description":"\u003cp\u003eRandom string of GitHub zen.\u003c/p\u003e"}],"availability":["repository","organization","app","business","marketplace"],"action":"default","category":"ping"}},{"name":"project_card","actionTypes":["converted","created","deleted","edited","moved"],"data":{"descriptionHtml":"\u003cp\u003eA note in a project (classic) was converted to an issue.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a card on a project (classic). For more information, see \"\u003ca href=\"https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards\"\u003eAbout projects (classic)\u003c/a\u003e.\" For information about the API to manage classic projects, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#project\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/projects\"\u003eProjects (classic)\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eFor activity relating to a project (classic) or a column on a project (classic), use the \u003ccode\u003eproject\u003c/code\u003e and \u003ccode\u003eproject_column\u003c/code\u003e event.\u003c/p\u003e\n\u003cp\u003eThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the \u003ccode\u003eprojects_v2\u003c/code\u003e event instead.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["converted"],"childParamsGroups":[]},{"type":"object","name":"changes","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"project_card","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"converted","category":"project_card"}},{"name":"project","actionTypes":["closed","created","deleted","edited","reopened"],"data":{"descriptionHtml":"\u003cp\u003eA project (classic) was closed.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a project (classic). For more information, see \"\u003ca href=\"https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards\"\u003eAbout projects (classic)\u003c/a\u003e.\" For information about the API to manage classic projects, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#project\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/projects\"\u003eProjects (classic)\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eFor activity relating to a card or column on a project (classic), use the \u003ccode\u003eproject_card\u003c/code\u003e and \u003ccode\u003eproject_column\u003c/code\u003e event.\u003c/p\u003e\n\u003cp\u003eThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the \u003ccode\u003eprojects_v2\u003c/code\u003e event instead.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["closed"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"project","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"closed","category":"project"}},{"name":"project_column","actionTypes":["created","deleted","edited","moved"],"data":{"descriptionHtml":"\u003cp\u003eA column was added to a project (classic).\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a column on a project (classic). For more information, see \"\u003ca href=\"https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards\"\u003eAbout projects (classic)\u003c/a\u003e.\" For information about the API to manage classic projects, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#project\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/projects\"\u003eProjects (classic)\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eFor activity relating to a project (classic) or a card on a project (classic), use the \u003ccode\u003eproject\u003c/code\u003e and \u003ccode\u003eproject_card\u003c/code\u003e event.\u003c/p\u003e\n\u003cp\u003eThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the \u003ccode\u003eprojects_v2\u003c/code\u003e event instead.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["created"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"project_column","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"created","category":"project_column"}},{"name":"projects_v2","actionTypes":["closed","created","deleted","edited","reopened"],"data":{"descriptionHtml":"\u003cp\u003eA project in the organization was closed.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to an organization-level project. For more information, see \"\u003ca href=\"https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects\"\u003eAbout Projects\u003c/a\u003e.\" For information about the Projects API, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#projectv2\"\u003ethe GraphQL documentation\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eFor activity relating to a item on a project, use the \u003ccode\u003eprojects_v2_item\u003c/code\u003e event. For activity relating to Projects (classic), use the \u003ccode\u003eproject\u003c/code\u003e, \u003ccode\u003eproject_card\u003c/code\u003e, and \u003ccode\u003eproject_column\u003c/code\u003e events instead.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\u003c/p\u003e\n\u003cdiv class=\"ghd-alert ghd-alert-accent\"\u003e\u003cp class=\"ghd-alert-title\"\u003e\u003csvg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden\u003e\u003cpath d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\u003e\u003c/path\u003e\u003c/svg\u003eNote\u003c/p\u003e\n\u003cp\u003e\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the \u003ca href=\"https://github.com/orgs/community/discussions/17405\"\u003eProjects webhook feedback discussion\u003c/a\u003e.\u003c/p\u003e\n\u003c/div\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["closed"],"childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"projects_v2","in":"body","description":"\u003cp\u003eA projects v2 project\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["organization"],"action":"closed","category":"projects_v2"}},{"name":"projects_v2_item","actionTypes":["archived","converted","created","deleted","edited","reordered","restored"],"data":{"descriptionHtml":"\u003cp\u003eAn item on an organization project was archived. For more information, see \"\u003ca href=\"https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project\"\u003eArchiving items from your project\u003c/a\u003e.\"\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"\u003ca href=\"https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects\"\u003eAbout Projects\u003c/a\u003e.\" For information about the Projects API, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#projectv2item\"\u003ethe GraphQL documentation\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eFor activity relating to a project (instead of an item on a project), use the \u003ccode\u003eprojects_v2\u003c/code\u003e event. For activity relating to Projects (classic), use the \u003ccode\u003eproject\u003c/code\u003e, \u003ccode\u003eproject_card\u003c/code\u003e, and \u003ccode\u003eproject_column\u003c/code\u003e events instead.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\u003c/p\u003e\n\u003cdiv class=\"ghd-alert ghd-alert-accent\"\u003e\u003cp class=\"ghd-alert-title\"\u003e\u003csvg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden\u003e\u003cpath d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\u003e\u003c/path\u003e\u003c/svg\u003eNote\u003c/p\u003e\n\u003cp\u003e\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the \u003ca href=\"https://github.com/orgs/community/discussions/17405\"\u003eProjects webhook feedback discussion\u003c/a\u003e.\u003c/p\u003e\n\u003c/div\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["archived"],"childParamsGroups":[]},{"type":"object","name":"changes","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"projects_v2_item","in":"body","description":"\u003cp\u003eAn item belonging to a project\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["organization"],"action":"archived","category":"projects_v2_item"}},{"name":"projects_v2_status_update","actionTypes":["created","deleted","edited"],"data":{"descriptionHtml":"\u003cp\u003eA status update was added to a project in the organization.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"\u003ca href=\"https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects\"\u003eAbout Projects\u003c/a\u003e.\"\u003c/p\u003e\n\u003cp\u003eFor activity relating to a project, use the \u003ccode\u003eprojects_v2\u003c/code\u003e event.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\u003c/p\u003e\n\u003cdiv class=\"ghd-alert ghd-alert-accent\"\u003e\u003cp class=\"ghd-alert-title\"\u003e\u003csvg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden\u003e\u003cpath d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\u003e\u003c/path\u003e\u003c/svg\u003eNote\u003c/p\u003e\n\u003cp\u003e\nTo share feedback about projects webhooks with GitHub, see the \u003ca href=\"https://github.com/orgs/community/discussions/17405\"\u003eProjects webhook feedback discussion\u003c/a\u003e.\u003c/p\u003e\n\u003c/div\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["created"],"childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"projects_v2_status_update","in":"body","description":"\u003cp\u003eAn status update belonging to a project\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["organization"],"action":"created","category":"projects_v2_status_update"}},{"name":"public","actionTypes":["default"],"data":{"descriptionHtml":"","summaryHtml":"\u003cp\u003eThis event occurs when repository visibility changes from private to public. For more information, see \"\u003ca href=\"https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility\"\u003eSetting repository visibility\u003c/a\u003e.\"\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"default","category":"public"}},{"name":"pull_request","actionTypes":["assigned","auto_merge_disabled","auto_merge_enabled","closed","converted_to_draft","demilestoned","dequeued","edited","enqueued","labeled","locked","milestoned","opened","ready_for_review","reopened","review_request_removed","review_requested","synchronize","unassigned","unlabeled","unlocked"],"data":{"descriptionHtml":"\u003cp\u003eA pull request was assigned to a user.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity on a pull request. For more information, see \"\u003ca href=\"https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests\"\u003eAbout pull requests\u003c/a\u003e.\" For information about the APIs to manage pull requests, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#pullrequest\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/pulls/pulls\"\u003ePulls\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the \u003ccode\u003epull_request_review\u003c/code\u003e, \u003ccode\u003epull_request_review_comment\u003c/code\u003e, \u003ccode\u003eissue_comment\u003c/code\u003e, or \u003ccode\u003epull_request_review_thread\u003c/code\u003e events instead.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["assigned"],"childParamsGroups":[]},{"type":"object or null","name":"assignee","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"integer","name":"number","in":"body","description":"\u003cp\u003eThe pull request number.\u003c/p\u003e","isRequired":true},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"pull_request","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"assigned","category":"pull_request"}},{"name":"pull_request_review_comment","actionTypes":["created","deleted","edited"],"data":{"descriptionHtml":"\u003cp\u003eA comment on a pull request diff was created.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"\u003ca href=\"https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\"\u003eCommenting on a pull request\u003c/a\u003e.\" For information about the APIs to manage pull request review comments, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/pulls/comments\"\u003ePull request review comments\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eFor activity related to pull request reviews, pull request comments, or pull request review threads, use the \u003ccode\u003epull_request_review\u003c/code\u003e, \u003ccode\u003eissue_comment\u003c/code\u003e, or \u003ccode\u003epull_request_review_thread\u003c/code\u003e events instead.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["created"],"childParamsGroups":[]},{"type":"object","name":"comment","in":"body","description":"\u003cp\u003eThe \u003ca href=\"https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request\"\u003ecomment\u003c/a\u003e itself.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"pull_request","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"created","category":"pull_request_review_comment"}},{"name":"pull_request_review","actionTypes":["dismissed","edited","submitted"],"data":{"descriptionHtml":"\u003cp\u003eA review on a pull request was dismissed.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"\u003ca href=\"https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews\"\u003eAbout pull request reviews\u003c/a\u003e.\" For information about the APIs to manage pull request reviews, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#pullrequestreview\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/pulls/reviews\"\u003ePull request reviews\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eFor activity related to pull request review comments, pull request comments, or pull request review threads, use the \u003ccode\u003epull_request_review_comment\u003c/code\u003e, \u003ccode\u003eissue_comment\u003c/code\u003e, or \u003ccode\u003epull_request_review_thread\u003c/code\u003e events instead.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["dismissed"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"pull_request","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"review","in":"body","description":"\u003cp\u003eThe review that was affected.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"dismissed","category":"pull_request_review"}},{"name":"pull_request_review_thread","actionTypes":["resolved","unresolved"],"data":{"descriptionHtml":"\u003cp\u003eA comment thread on a pull request was marked as resolved.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"\u003ca href=\"https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews\"\u003eAbout pull request reviews\u003c/a\u003e.\" For information about the APIs to manage pull request reviews, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#pullrequestreviewthread\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/pulls/comments\"\u003ePull request review comments\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eFor activity related to pull request review comments, pull request comments, or pull request reviews, use the \u003ccode\u003epull_request_review_comment\u003c/code\u003e, \u003ccode\u003eissue_comment\u003c/code\u003e, or \u003ccode\u003epull_request_review\u003c/code\u003e events instead.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["resolved"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"pull_request","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"thread","in":"body","description":"","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"resolved","category":"pull_request_review_thread"}},{"name":"push","actionTypes":["default"],"data":{"descriptionHtml":"","summaryHtml":"\u003cp\u003eThis event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the \u003ca href=\"#delete\"\u003e\u003ccode\u003edelete\u003c/code\u003e\u003c/a\u003e webhook event.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\u003c/p\u003e\n\u003cdiv class=\"ghd-alert ghd-alert-accent\"\u003e\u003cp class=\"ghd-alert-title\"\u003e\u003csvg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden\u003e\u003cpath d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\u003e\u003c/path\u003e\u003c/svg\u003eNote\u003c/p\u003e\n\u003cp\u003e\nEvents will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.\u003c/p\u003e\n\u003c/div\u003e","bodyParameters":[{"type":"string","name":"after","in":"body","description":"\u003cp\u003eThe SHA of the most recent commit on \u003ccode\u003eref\u003c/code\u003e after the push.\u003c/p\u003e","isRequired":true},{"type":"string or null","name":"base_ref","in":"body","description":"","isRequired":true},{"type":"string","name":"before","in":"body","description":"\u003cp\u003eThe SHA of the most recent commit on \u003ccode\u003eref\u003c/code\u003e before the push.\u003c/p\u003e","isRequired":true},{"type":"array of objects","name":"commits","in":"body","description":"\u003cp\u003eAn array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the \u003ccode\u003ecompare\u003c/code\u003e between the \u003ccode\u003ebefore\u003c/code\u003e commit and the \u003ccode\u003eafter\u003c/code\u003e commit.) The array includes a maximum of 2048 commits. If necessary, you can use the \u003ca href=\"https://docs.github.com/rest/commits\"\u003eCommits API\u003c/a\u003e to fetch additional commits.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"string","name":"compare","in":"body","description":"\u003cp\u003eURL that shows the changes in this \u003ccode\u003eref\u003c/code\u003e update, from the \u003ccode\u003ebefore\u003c/code\u003e commit to the \u003ccode\u003eafter\u003c/code\u003e commit. For a newly created \u003ccode\u003eref\u003c/code\u003e that is directly based on the default branch, this is the comparison between the head of the default branch and the \u003ccode\u003eafter\u003c/code\u003e commit. Otherwise, this shows all commits until the \u003ccode\u003eafter\u003c/code\u003e commit.\u003c/p\u003e","isRequired":true},{"type":"boolean","name":"created","in":"body","description":"\u003cp\u003eWhether this push created the \u003ccode\u003eref\u003c/code\u003e.\u003c/p\u003e","isRequired":true},{"type":"boolean","name":"deleted","in":"body","description":"\u003cp\u003eWhether this push deleted the \u003ccode\u003eref\u003c/code\u003e.\u003c/p\u003e","isRequired":true},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"boolean","name":"forced","in":"body","description":"\u003cp\u003eWhether this push was a force push of the \u003ccode\u003eref\u003c/code\u003e.\u003c/p\u003e","isRequired":true},{"type":"object or null","name":"head_commit","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"pusher","in":"body","description":"\u003cp\u003eMetaproperties for Git author/committer information.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"string","name":"ref","in":"body","description":"\u003cp\u003eThe full git ref that was pushed. Example: \u003ccode\u003erefs/heads/main\u003c/code\u003e or \u003ccode\u003erefs/tags/v3.14.1\u003c/code\u003e.\u003c/p\u003e","isRequired":true},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eA git repository\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"default","category":"push"}},{"name":"registry_package","actionTypes":["published","updated"],"data":{"descriptionHtml":"\u003cp\u003eA package was published to a registry.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to GitHub Packages. For more information, see \"\u003ca href=\"https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages\"\u003eIntroduction to GitHub Packages\u003c/a\u003e.\" For information about the APIs to manage GitHub Packages, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#package\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/packages\"\u003ePackages\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\u003c/p\u003e\n\u003cdiv class=\"ghd-alert ghd-alert-accent\"\u003e\u003cp class=\"ghd-alert-title\"\u003e\u003csvg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden\u003e\u003cpath d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\u003e\u003c/path\u003e\u003c/svg\u003eNote\u003c/p\u003e\n\u003cp\u003e\nGitHub recommends that you use the newer \u003ccode\u003epackage\u003c/code\u003e event instead.\u003c/p\u003e\n\u003c/div\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["published"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"registry_package","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"published","category":"registry_package"}},{"name":"release","actionTypes":["created","deleted","edited","prereleased","published","released","unpublished"],"data":{"descriptionHtml":"\u003cp\u003eA draft was saved, or a release or pre-release was published without previously being saved as a draft.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to releases. For more information, see \"\u003ca href=\"https://docs.github.com/repositories/releasing-projects-on-github/about-releases\"\u003eAbout releases\u003c/a\u003e.\" For information about the APIs to manage releases, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#release\"\u003ethe GraphQL API documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/releases\"\u003eReleases\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["created"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"release","in":"body","description":"\u003cp\u003eThe \u003ca href=\"https://docs.github.com/rest/releases/releases/#get-a-release\"\u003erelease\u003c/a\u003e object.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"created","category":"release"}},{"name":"repository_advisory","actionTypes":["published","reported"],"data":{"descriptionHtml":"\u003cp\u003eA repository security advisory was published.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"\u003ca href=\"https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories\"\u003eAbout GitHub Security Advisories for repositories\u003c/a\u003e.\"\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["published"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"repository_advisory","in":"body","description":"\u003cp\u003eA repository security advisory.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"published","category":"repository_advisory"}},{"name":"repository","actionTypes":["archived","created","deleted","edited","privatized","publicized","renamed","transferred","unarchived"],"data":{"descriptionHtml":"\u003cp\u003eA repository was archived.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to repositories. For more information, see \"\u003ca href=\"https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories\"\u003eAbout repositories\u003c/a\u003e.\" For information about the APIs to manage repositories, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#repository\"\u003ethe GraphQL documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/repos\"\u003eRepositories\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["archived"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["business","repository","organization","app"],"action":"archived","category":"repository"}},{"name":"repository_dispatch","actionTypes":["default"],"data":{"descriptionHtml":"","summaryHtml":"\u003cp\u003eThis event occurs when a GitHub App sends a \u003ccode\u003ePOST\u003c/code\u003e request to \u003ccode\u003e/repos/{owner}/{repo}/dispatches\u003c/code\u003e. For more information, see \u003ca href=\"https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event\"\u003ethe REST API documentation for creating a repository dispatch event\u003c/a\u003e. In the payload, the \u003ccode\u003eaction\u003c/code\u003e will be the \u003ccode\u003eevent_type\u003c/code\u003e that was specified in the \u003ccode\u003ePOST /repos/{owner}/{repo}/dispatches\u003c/code\u003e request body.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"\u003cp\u003eThe \u003ccode\u003eevent_type\u003c/code\u003e that was specified in the \u003ccode\u003ePOST /repos/{owner}/{repo}/dispatches\u003c/code\u003e request body.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"string","name":"branch","in":"body","description":"","isRequired":true},{"type":"object or null","name":"client_payload","in":"body","description":"\u003cp\u003eThe \u003ccode\u003eclient_payload\u003c/code\u003e that was specified in the \u003ccode\u003ePOST /repos/{owner}/{repo}/dispatches\u003c/code\u003e request body.\u003c/p\u003e","isRequired":true},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["app"],"action":"default","category":"repository_dispatch"}},{"name":"repository_import","actionTypes":["default"],"data":{"descriptionHtml":"","summaryHtml":"\u003cp\u003eThis event occurs when a repository is imported to GitHub. For more information, see \"\u003ca href=\"https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer\"\u003eImporting a repository with GitHub Importer\u003c/a\u003e.\" For more information about the API to manage imports, see \u003ca href=\"https://docs.github.com/rest/migrations/source-imports\"\u003ethe REST API documentation\u003c/a\u003e.\u003c/p\u003e","bodyParameters":[{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"string","name":"status","in":"body","description":"","isRequired":true,"enum":["success","cancelled","failure"]}],"availability":["repository","organization"],"action":"default","category":"repository_import"}},{"name":"repository_ruleset","actionTypes":["created","deleted","edited"],"data":{"descriptionHtml":"\u003cp\u003eA repository ruleset was created.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"\u003ca href=\"https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets\"\u003eManaging rulesets\u003c/a\u003e.\"\nFor more information on managing rulesets via the APIs, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#repositoryruleset\"\u003eRepository ruleset\u003c/a\u003e in the GraphQL documentation or \"\u003ca href=\"https://docs.github.com/rest/repos/rules\"\u003eRepository rules\u003c/a\u003e\" and \"\u003ca href=\"https://docs.github.com/rest/orgs/rules\"\u003eOrganization rules\u003c/a\u003e in the REST API documentation.\"\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["created"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository_ruleset","in":"body","description":"\u003cp\u003eA set of rules to apply when specified conditions are met.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"created","category":"repository_ruleset"}},{"name":"repository_vulnerability_alert","actionTypes":["create","dismiss","reopen","resolve"],"data":{"descriptionHtml":"\u003cp\u003eA repository vulnerability alert was created.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a security vulnerability alert in a repository.\u003c/p\u003e\n\u003cdiv class=\"ghd-alert ghd-alert-attention\"\u003e\u003cp class=\"ghd-alert-title\"\u003e\u003csvg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden\u003e\u003cpath d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"\u003e\u003c/path\u003e\u003c/svg\u003eWarning\u003c/p\u003e\n\u003cp\u003e\n\u003cstrong\u003eClosing down notice:\u003c/strong\u003e This event is closing down. Use the \u003ccode\u003edependabot_alert\u003c/code\u003e event instead.\u003c/p\u003e\n\u003c/div\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["create"],"childParamsGroups":[]},{"type":"object","name":"alert","in":"body","description":"\u003cp\u003eThe security alert of the vulnerable dependency.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization"],"action":"create","category":"repository_vulnerability_alert"}},{"name":"secret_scanning_alert","actionTypes":["created","publicly_leaked","reopened","resolved","validated"],"data":{"descriptionHtml":"\u003cp\u003eA secret scanning alert was created.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"\u003ca href=\"https://docs.github.com/code-security/secret-scanning/about-secret-scanning\"\u003eAbout secret scanning\u003c/a\u003e.\" For information about the API to manage secret scanning alerts, see \"\u003ca href=\"https://docs.github.com/rest/secret-scanning\"\u003eSecret scanning\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eFor activity relating to secret scanning alert locations, use the \u003ccode\u003esecret_scanning_alert_location\u003c/code\u003e event.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["created"],"childParamsGroups":[]},{"type":"object","name":"alert","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"created","category":"secret_scanning_alert"}},{"name":"secret_scanning_alert_location","actionTypes":["created"],"data":{"descriptionHtml":"\u003cp\u003eA new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\u003c/p\u003e\n\u003cp\u003eFor more information about secret scanning, see \"\u003ca href=\"https://docs.github.com/code-security/secret-scanning/about-secret-scanning\"\u003eAbout secret scanning\u003c/a\u003e.\" For information about the API to manage secret scanning alerts, see \"\u003ca href=\"https://docs.github.com/rest/secret-scanning\"\u003eSecret scanning\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eFor activity relating to secret scanning alerts, use the \u003ccode\u003esecret_scanning_alert\u003c/code\u003e event.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","enum":["created"],"childParamsGroups":[]},{"type":"object","name":"alert","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"location","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"created","category":"secret_scanning_alert_location"}},{"name":"secret_scanning_scan","actionTypes":["completed"],"data":{"descriptionHtml":"\u003cp\u003eA secret scanning scan was completed.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"\u003ca href=\"https://docs.github.com/code-security/secret-scanning/about-secret-scanning\"\u003eAbout secret scanning\u003c/a\u003e.\"\u003c/p\u003e\n\u003cp\u003eScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"\u003ca href=\"https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns\"\u003eAbout custom patterns\u003c/a\u003e.\"\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["completed"],"childParamsGroups":[]},{"type":"string","name":"type","in":"body","description":"\u003cp\u003eWhat type of scan was completed\u003c/p\u003e","isRequired":true,"enum":["backfill","custom-pattern-backfill","pattern-version-backfill"]},{"type":"string","name":"source","in":"body","description":"\u003cp\u003eWhat type of content was scanned\u003c/p\u003e","isRequired":true,"enum":["git","issues","pull-requests","discussions","wiki"]},{"type":"string","name":"started_at","in":"body","description":"\u003cp\u003eThe time that the alert was resolved in ISO 8601 format: \u003ccode\u003eYYYY-MM-DDTHH:MM:SSZ\u003c/code\u003e.\u003c/p\u003e","isRequired":true},{"type":"string","name":"completed_at","in":"body","description":"\u003cp\u003eThe time that the alert was resolved in ISO 8601 format: \u003ccode\u003eYYYY-MM-DDTHH:MM:SSZ\u003c/code\u003e.\u003c/p\u003e","isRequired":true},{"type":"array of strings or null","name":"secret_types","in":"body","description":"\u003cp\u003eList of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates\u003c/p\u003e"},{"type":"string or null","name":"custom_pattern_name","in":"body","description":"\u003cp\u003eIf the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated\u003c/p\u003e"},{"type":"string or null","name":"custom_pattern_scope","in":"body","description":"\u003cp\u003eIf the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated\u003c/p\u003e","enum":["repository","organization","enterprise",null]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"completed","category":"secret_scanning_scan"}},{"name":"security_advisory","actionTypes":["published","updated","withdrawn"],"data":{"descriptionHtml":"\u003cp\u003eA security advisory was published to the GitHub community.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"\u003ca href=\"https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories\"\u003eAbout global security advisories\u003c/a\u003e.\" For information about the API to manage security advisories, see \u003ca href=\"https://docs.github.com/rest/security-advisories/global-advisories\"\u003ethe REST API documentation\u003c/a\u003e or \u003ca href=\"https://docs.github.com/graphql/reference/objects#securityadvisory\"\u003ethe GraphQL documentation\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"\u003ca href=\"https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts\"\u003eAbout Dependabot alerts\u003c/a\u003e.\"\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["published"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"security_advisory","in":"body","description":"\u003cp\u003eThe details of the security advisory, including summary, description, and severity.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","childParamsGroups":[]}],"availability":["app"],"action":"published","category":"security_advisory"}},{"name":"security_and_analysis","actionTypes":["default"],"data":{"descriptionHtml":"","summaryHtml":"\u003cp\u003eThis event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"\u003ca href=\"https://docs.github.com/code-security/getting-started/github-security-features\"\u003eGitHub security features\u003c/a\u003e.\"\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"object","name":"changes","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eFull Repository\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"default","category":"security_and_analysis"}},{"name":"sponsorship","actionTypes":["cancelled","created","edited","pending_cancellation","pending_tier_change","tier_changed"],"data":{"descriptionHtml":"\u003cp\u003eA sponsorship was cancelled and the last billing cycle has ended.\u003c/p\u003e\n\u003cp\u003eThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a sponsorship listing. For more information, see \"\u003ca href=\"https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors\"\u003eAbout GitHub Sponsors\u003c/a\u003e.\" For information about the API to manage sponsors, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#sponsorship\"\u003ethe GraphQL documentation\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eYou can only create a sponsorship webhook on GitHub.com. For more information, see \"\u003ca href=\"https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account\"\u003eConfiguring webhooks for events in your sponsored account\u003c/a\u003e.\"\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["cancelled"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sponsorship","in":"body","description":"","isRequired":true,"childParamsGroups":[]}],"availability":["sponsors_listing"],"action":"cancelled","category":"sponsorship"}},{"name":"star","actionTypes":["created","deleted"],"data":{"descriptionHtml":"\u003cp\u003eSomeone starred a repository.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to repository stars. For more information about stars, see \"\u003ca href=\"https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars\"\u003eSaving repositories with stars\u003c/a\u003e.\" For information about the APIs to manage stars, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#starredrepositoryconnection\"\u003ethe GraphQL documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/activity/starring\"\u003eStarring\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["created"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"string or null","name":"starred_at","in":"body","description":"\u003cp\u003eThe time the star was created. This is a timestamp in ISO 8601 format: \u003ccode\u003eYYYY-MM-DDTHH:MM:SSZ\u003c/code\u003e. Will be \u003ccode\u003enull\u003c/code\u003e for the \u003ccode\u003edeleted\u003c/code\u003e action.\u003c/p\u003e","isRequired":true}],"availability":["repository","organization","app"],"action":"created","category":"star"}},{"name":"status","actionTypes":["default"],"data":{"descriptionHtml":"","summaryHtml":"\u003cp\u003eThis event occurs when the status of a Git commit changes. For example, commits can be marked as \u003ccode\u003eerror\u003c/code\u003e, \u003ccode\u003efailure\u003c/code\u003e, \u003ccode\u003epending\u003c/code\u003e, or \u003ccode\u003esuccess\u003c/code\u003e. For more information, see \"\u003ca href=\"https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks\"\u003eAbout status checks\u003c/a\u003e.\" For information about the APIs to manage commit statuses, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#status\"\u003ethe GraphQL documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/commits/statuses\"\u003eCommit statuses\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string or null","name":"avatar_url","in":"body","description":""},{"type":"array of objects","name":"branches","in":"body","description":"\u003cp\u003eAn array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"commit","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"string","name":"context","in":"body","description":"","isRequired":true},{"type":"string","name":"created_at","in":"body","description":"","isRequired":true},{"type":"string or null","name":"description","in":"body","description":"\u003cp\u003eThe optional human-readable description added to the status.\u003c/p\u003e","isRequired":true},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"integer","name":"id","in":"body","description":"\u003cp\u003eThe unique identifier of the status.\u003c/p\u003e","isRequired":true},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"string","name":"name","in":"body","description":"","isRequired":true},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"string","name":"sha","in":"body","description":"\u003cp\u003eThe Commit SHA.\u003c/p\u003e","isRequired":true},{"type":"string","name":"state","in":"body","description":"\u003cp\u003eThe new state. Can be \u003ccode\u003epending\u003c/code\u003e, \u003ccode\u003esuccess\u003c/code\u003e, \u003ccode\u003efailure\u003c/code\u003e, or \u003ccode\u003eerror\u003c/code\u003e.\u003c/p\u003e","isRequired":true,"enum":["pending","success","failure","error"]},{"type":"string or null","name":"target_url","in":"body","description":"\u003cp\u003eThe optional link added to the status.\u003c/p\u003e","isRequired":true},{"type":"string","name":"updated_at","in":"body","description":"","isRequired":true}],"availability":["repository","organization","app"],"action":"default","category":"status"}},{"name":"sub_issues","actionTypes":["parent_issue_added","parent_issue_removed","sub_issue_added","sub_issue_removed"],"data":{"descriptionHtml":"\u003cp\u003eA parent issue was added to an issue.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to sub-issues.\u003c/p\u003e\n\u003cp\u003eFor activity relating to issues more generally, use the \u003ccode\u003eissues\u003c/code\u003e event instead.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["parent_issue_added"],"childParamsGroups":[]},{"type":"number","name":"parent_issue_id","in":"body","description":"\u003cp\u003eThe ID of the parent issue.\u003c/p\u003e","isRequired":true},{"type":"object","name":"parent_issue","in":"body","description":"\u003cp\u003eIssues are a great way to keep track of tasks, enhancements, and bugs for your projects.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"parent_issue_repo","in":"body","description":"\u003cp\u003eA repository on GitHub.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"number","name":"sub_issue_id","in":"body","description":"\u003cp\u003eThe ID of the sub-issue.\u003c/p\u003e","isRequired":true},{"type":"object","name":"sub_issue","in":"body","description":"\u003cp\u003eIssues are a great way to keep track of tasks, enhancements, and bugs for your projects.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"parent_issue_added","category":"sub_issues"}},{"name":"team_add","actionTypes":["default"],"data":{"descriptionHtml":"","summaryHtml":"\u003cp\u003eThis event occurs when a team is added to a repository.\nFor more information, see \"\u003ca href=\"https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository\"\u003eManaging teams and people with access to your repository\u003c/a\u003e.\"\u003c/p\u003e\n\u003cp\u003eFor activity relating to teams, see the \u003ccode\u003eteams\u003c/code\u003e event.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.\u003c/p\u003e","bodyParameters":[{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"team","in":"body","description":"\u003cp\u003eGroups of organization members that gives permissions on specified repositories.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"default","category":"team_add"}},{"name":"team","actionTypes":["added_to_repository","created","deleted","edited","removed_from_repository"],"data":{"descriptionHtml":"\u003cp\u003eA team was granted access to a repository.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to teams in an organization.\nFor more information, see \"\u003ca href=\"https://docs.github.com/organizations/organizing-members-into-teams/about-teams\"\u003eAbout teams\u003c/a\u003e.\"\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["added_to_repository"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eA git repository\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"team","in":"body","description":"\u003cp\u003eGroups of organization members that gives permissions on specified repositories.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["organization","business","app"],"action":"added_to_repository","category":"team"}},{"name":"watch","actionTypes":["started"],"data":{"descriptionHtml":"\u003cp\u003eSomeone started watching the repository.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"\u003ca href=\"https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions\"\u003eManaging your subscriptions\u003c/a\u003e.\" For information about the APIs to manage watching, see \"\u003ca href=\"https://docs.github.com/rest/activity/watching\"\u003eWatching\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["started"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]}],"availability":["repository","organization","app"],"action":"started","category":"watch"}},{"name":"workflow_dispatch","actionTypes":["default"],"data":{"descriptionHtml":"","summaryHtml":"\u003cp\u003eThis event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"\u003ca href=\"https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow\"\u003eManually running a workflow\u003c/a\u003e.\"\u003c/p\u003e\n\u003cp\u003eFor activity relating to workflow runs, use the \u003ccode\u003eworkflow_run\u003c/code\u003e event.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object or null","name":"inputs","in":"body","description":"","isRequired":true},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"string","name":"ref","in":"body","description":"","isRequired":true},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"string","name":"workflow","in":"body","description":"","isRequired":true}],"availability":["app"],"action":"default","category":"workflow_dispatch"}},{"name":"workflow_job","actionTypes":["completed","in_progress","queued","waiting"],"data":{"descriptionHtml":"\u003cp\u003eA job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"\u003ca href=\"https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow\"\u003eUsing jobs in a workflow\u003c/a\u003e.\" For information about the API to manage workflow jobs, see \"\u003ca href=\"https://docs.github.com/rest/actions/workflow-jobs\"\u003eWorkflow jobs\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eFor activity relating to a workflow run instead of a job in a workflow run, use the \u003ccode\u003eworkflow_run\u003c/code\u003e event.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["completed"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"workflow_job","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"deployment","in":"body","description":"\u003cp\u003eA request for a specific ref(branch,sha,tag) to be deployed\u003c/p\u003e","childParamsGroups":[]}],"availability":["business","repository","organization","app"],"action":"completed","category":"workflow_job"}},{"name":"workflow_run","actionTypes":["completed","in_progress","requested"],"data":{"descriptionHtml":"\u003cp\u003eA workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.\u003c/p\u003e","summaryHtml":"\u003cp\u003eThis event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"\u003ca href=\"https://docs.github.com/actions/using-workflows/about-workflows\"\u003eAbout workflows\u003c/a\u003e.\" For information about the APIs to manage workflow runs, see \u003ca href=\"https://docs.github.com/graphql/reference/objects#workflowrun\"\u003ethe GraphQL documentation\u003c/a\u003e or \"\u003ca href=\"https://docs.github.com/rest/actions/workflow-runs\"\u003eWorkflow runs\u003c/a\u003e\" in the REST API documentation.\u003c/p\u003e\n\u003cp\u003eFor activity relating to a job in a workflow run, use the \u003ccode\u003eworkflow_job\u003c/code\u003e event.\u003c/p\u003e\n\u003cp\u003eTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.\u003c/p\u003e","bodyParameters":[{"type":"string","name":"action","in":"body","description":"","isRequired":true,"enum":["completed"],"childParamsGroups":[]},{"type":"object","name":"enterprise","in":"body","description":"\u003cp\u003eAn enterprise on GitHub. Webhook payloads contain the \u003ccode\u003eenterprise\u003c/code\u003e property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"\u003ca href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\"\u003eAbout enterprise accounts\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"installation","in":"body","description":"\u003cp\u003eThe GitHub App installation. Webhook payloads contain the \u003ccode\u003einstallation\u003c/code\u003e property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"\u003ca href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\"\u003eUsing webhooks with GitHub Apps\u003c/a\u003e.\"\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"organization","in":"body","description":"\u003cp\u003eA GitHub organization. Webhook payloads contain the \u003ccode\u003eorganization\u003c/code\u003e property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.\u003c/p\u003e","childParamsGroups":[]},{"type":"object","name":"repository","in":"body","description":"\u003cp\u003eThe repository on GitHub where the event occurred. Webhook payloads contain the \u003ccode\u003erepository\u003c/code\u003e property\nwhen the event occurs from activity in a repository.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"sender","in":"body","description":"\u003cp\u003eA GitHub user.\u003c/p\u003e","isRequired":true,"childParamsGroups":[]},{"type":"object or null","name":"workflow","in":"body","description":"","isRequired":true,"childParamsGroups":[]},{"type":"object","name":"workflow_run","in":"body","description":"","isRequired":true,"childParamsGroups":[]}],"availability":["business","repository","organization","app"],"action":"completed","category":"workflow_run"}}],"mainContext":{"breadcrumbs":[{"href":"/en/webhooks","title":"Webhooks"},{"href":"/en/webhooks/webhook-events-and-payloads","title":"Webhook events \u0026 payloads"}],"communityRedirect":{},"currentProduct":{"id":"webhooks","name":"Webhooks","href":"/webhooks","dir":"content/webhooks","toc":"content/webhooks/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.15","enterprise-server@3.14","enterprise-server@3.13","enterprise-server@3.12","enterprise-server@3.11"]},"currentProductName":"Webhooks","isHomepageVersion":false,"error":"","data":{"ui":{"alerts":{"NOTE":"Note","IMPORTANT":"Important","WARNING":"Warning","TIP":"Tip","CAUTION":"Caution"},"header":{"github_docs":"GitHub Docs","contact":"Contact","notices":{"release_candidate":" is currently available as a \u003ca href=\"/admin/overview/about-upgrades-to-new-releases\"\u003erelease candidate\u003c/a\u003e.","early_access":"📣 Please \u003cb\u003edo not share\u003c/b\u003e this URL publicly. This page contains content about a private preview feature.","release_notes_use_latest":"Please use the latest release for the latest security, performance, and bug fixes.","ghes_release_notes_upgrade_patch_only":"📣 This is not the \u003ca href=\"#{{ latestPatch }}\"\u003elatest patch release\u003c/a\u003e of Enterprise Server.","ghes_release_notes_upgrade_release_only":"📣 This is not the \u003ca href=\"/enterprise-server@{{ latestRelease }}/admin/release-notes\"\u003elatest release\u003c/a\u003e of Enterprise Server.","ghes_release_notes_upgrade_patch_and_release":"📣 This is not the \u003ca href=\"#{{ latestPatch }}\"\u003elatest patch release\u003c/a\u003e of this release series, and this is not the \u003ca href=\"/enterprise-server@{{ latestRelease }}/admin/release-notes\"\u003elatest release\u003c/a\u003e of Enterprise Server."},"sign_up_cta":"Sign up","menu":"Menu","open_menu_label":"Open menu","go_home":"Home"},"search":{"input":{"aria_label":"Open search overlay","placeholder":"Search or ask Copilot"},"overlay":{"input_aria_label":"Search or ask Copilot","suggestions_list_aria_label":"Search suggestions","ai_suggestions_list_aria_label":"Copilot search suggestions","general_suggestions_list_aria_label":"Docs search suggestions","general_suggestions_list_heading":"Search docs","ai_autocomplete_list_heading":"Ask Copilot","give_feedback":"Give feedback","beta_tag":"Beta","return_to_search":"Return to search","clear_search_query":"Clear"},"ai":{"disclaimer":"Copilot uses AI. Check for mistakes by reviewing the links in the response.","references":"References from these articles","loading_status_message":"Loading Copilot response...","done_loading_status_message":"Done loading Copilot response","unable_to_answer":"Sorry, I'm unable to answer that question. Please try a different query.","copy_answer":"Copy answer","copied_announcement":"Copied!","thumbs_up":"This answer was helpful","thumbs_down":"This answer was not helpful","thumbs_announcement":"Thank you for your feedback!"},"failure":{"autocomplete_title":"There was an error loading autocomplete results.","ai_title":"There was an error loading the AI assistant.","description":"You can still use this field to search our docs."}},"old_search":{"description":"Enter a search term to find it in the GitHub Docs.","placeholder":"Search GitHub Docs","label":"Search GitHub Docs"},"survey":{"able_to_find":"Did you find what you needed?","yes":"Yes","no":"No","cancel":"Cancel","additional_feedback":"Can you tell us more about your rating? (Optional)","optional":"Optional","required":"Required","email_label":"Leave your email if we can contact you. (Optional)","email_validation":"Please enter a valid email address","send":"Send","feedback":"Thank you! We received your feedback.","not_support":"If you need a reply, please contact \u003ca href=\"https://support.github.com/\"\u003esupport\u003c/a\u003e.","privacy_policy":"Privacy policy","server_error":"Unable to process comment at the moment. Please try again."},"toc":{"getting_started":"Getting started","popular":"Popular","startHere":"Start here","whats_new":"What's new","videos":"Videos","all_changelogs":"All changelog posts"},"meta":{"default_description":"Get started, troubleshoot, and make the most of GitHub. Documentation for new users, developers, administrators, and all of GitHub's products."},"scroll_button":{"scroll_to_top":"Scroll to top"},"pages":{"article_version":"Article version","miniToc":"In this article","all_enterprise_releases":"All Enterprise Server releases","about_versions":"About versions","permissions_callout_title":"Who can use this feature?","video_from_transcript":"See video for this transcript"},"picker":{"language_picker_label":"Language","product_picker_default_text":"All products","version_picker_default_text":"Choose a version"},"footer":{"support_heading":"Help and support","legal_heading":"Legal","imprint":"Imprint","terms":"Terms","privacy":"Privacy","status":"Status","pricing":"Pricing","expert_services":"Expert services","blog":"Blog"},"contribution_cta":{"title":"Help us make these docs great!","body":"All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.","button":"Make a contribution","to_guidelines":"Learn how to contribute"},"support":{"still_need_help":"Still need help?","contact_support":"Contact support","ask_community":"Ask the GitHub community"},"rest":{"banner":{"api_versioned":"The REST API is now versioned.","api_version_info":"For more information, see \"\u003ca href=\"{{ versionWithApiVersion }}/rest/overview/api-versions\"\u003eAbout API versioning\u003c/a\u003e.\"","ghes_api_versioned":"After a site administrator upgrades your Enterprise Server instance to {{ firstGhesReleaseWithApiVersions.versionTitle }} or later, the REST API will be versioned. To learn how to find your instance's version, see \"\u003ca href=\"/{{ currentVersion }}/get-started/learning-about-github/about-versions-of-github-docs#github-enterprise-server\"\u003eAbout versions of GitHub Docs\u003c/a\u003e\".","redirect_notice":"We've recently moved some of the REST API documentation.","redirect_repo":"If you can't find what you're looking for, you might try the new {{ newRestPagesLinks }} REST API pages.","redirect_enterprise":"If you can't find what you're looking for, you might try the {{ actionsPageLink }} REST API page.","actions_api_title":"Actions"},"versioning":{"about_versions":"About REST API versions"},"overview":{"permissions":{"access":"Access","endpoints":"Endpoint","tokens":"Token types","additionalPermissions":"Additional permissions","uat":"UAT","iat":"IAT"}},"screen_reader_text_checkmark_icon":"Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint."},"domain_edit":{"name":"Domain name","edit":"Edit","edit_your":"Edit your domain name","experimental":"Experimental","your_name":"Your domain name","cancel":"Cancel","save":"Save","snippet_about":"Updating will include the new domain name in all code snippets across GitHub Docs.","learn_more":"Learn more","submission_failed":"Submission failed. Please try again in a minute."},"cookbook_landing":{"spotlight":"Spotlight","explore_articles":"Explore {{ number }} prompt articles","reset_filters":"Reset filters","search_articles":"Search articles","category":"Category","complexity":"Complexity"},"parameter_table":{"body":"Body parameters","webhook-body":"Webhook request body parameters","default":"Default","description":"Description","enum_description_title":"Can be one of","headers":"Headers","name":"Name","path":"Path parameters","query":"Query parameters","required":"Required","see_preview_notice":"See preview notice","see_preview_notices":"See preview notices","type":"Type","single_enum_description":"Value"},"webhooks":{"action_type_switch_error":"There was an error switching webhook action types.","action_type":"Action type","availability":"Availability for \u003ccode\u003e{{ WebhookName }}\u003c/code\u003e","webhook_payload_object":"Webhook payload object for \u003ccode\u003e{{ WebhookName }}\u003c/code\u003e","webhook_payload_example":"Webhook payload example","rephrase_availability":{"repository":"Repositories","organization":"Organizations","app":"GitHub Apps","business":"Enterprises","marketplace":"GitHub Marketplace","sponsors_listing":"Sponsored accounts"}}},"reusables":{},"variables":{"release_candidate":{"version":null}}},"currentCategory":"webhook-events-and-payloads","currentPathWithoutLanguage":"/webhooks/webhook-events-and-payloads","page":{"documentType":"article","type":null,"title":"Webhook events and payloads","fullTitle":"Webhook events and payloads - GitHub Docs","topics":["Webhooks"],"introPlainText":"Learn about when each webhook event occurs and what the payload contains.","applicableVersions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.15","enterprise-server@3.14","enterprise-server@3.13","enterprise-server@3.12","enterprise-server@3.11"],"hidden":false,"noEarlyAccessBanner":false},"enterpriseServerReleases":{"isOldestReleaseDeprecated":true,"oldestSupported":"3.11","nextDeprecationDate":"2024-12-19","supported":["3.15","3.14","3.13","3.12","3.11"]},"enterpriseServerVersions":["enterprise-server@3.15","enterprise-server@3.14","enterprise-server@3.13","enterprise-server@3.12","enterprise-server@3.11"],"allVersions":{"free-pro-team@latest":{"version":"free-pro-team@latest","versionTitle":"Free, Pro, \u0026 Team","apiVersions":["2022-11-28"],"latestApiVersion":"2022-11-28"},"enterprise-cloud@latest":{"version":"enterprise-cloud@latest","versionTitle":"Enterprise Cloud","apiVersions":["2022-11-28"],"latestApiVersion":"2022-11-28"},"enterprise-server@3.15":{"version":"enterprise-server@3.15","versionTitle":"Enterprise Server 3.15","apiVersions":["2022-11-28"],"latestApiVersion":"2022-11-28","isGHES":true},"enterprise-server@3.14":{"version":"enterprise-server@3.14","versionTitle":"Enterprise Server 3.14","apiVersions":["2022-11-28"],"latestApiVersion":"2022-11-28","isGHES":true},"enterprise-server@3.13":{"version":"enterprise-server@3.13","versionTitle":"Enterprise Server 3.13","apiVersions":["2022-11-28"],"latestApiVersion":"2022-11-28","isGHES":true},"enterprise-server@3.12":{"version":"enterprise-server@3.12","versionTitle":"Enterprise Server 3.12","apiVersions":["2022-11-28"],"latestApiVersion":"2022-11-28","isGHES":true},"enterprise-server@3.11":{"version":"enterprise-server@3.11","versionTitle":"Enterprise Server 3.11","apiVersions":["2022-11-28"],"latestApiVersion":"2022-11-28","isGHES":true}},"currentVersion":"free-pro-team@latest","currentProductTree":null,"sidebarTree":{"href":"/en/webhooks","title":"Webhooks","childPages":[{"href":"/en/webhooks/about-webhooks","title":"About webhooks","childPages":[]},{"href":"/en/webhooks/types-of-webhooks","title":"Types of webhooks","childPages":[]},{"href":"/en/webhooks/webhook-events-and-payloads","title":"Webhook events \u0026 payloads","childPages":[]},{"href":"/en/webhooks/using-webhooks","title":"Using webhooks","childPages":[{"href":"/en/webhooks/using-webhooks/creating-webhooks","title":"Create webhooks","childPages":[]},{"href":"/en/webhooks/using-webhooks/handling-webhook-deliveries","title":"Handle deliveries","childPages":[]},{"href":"/en/webhooks/using-webhooks/validating-webhook-deliveries","title":"Validate deliveries","childPages":[]},{"href":"/en/webhooks/using-webhooks/delivering-webhooks-to-private-systems","title":"Deliver to private systems","childPages":[]},{"href":"/en/webhooks/using-webhooks/editing-webhooks","title":"Edit webhooks","childPages":[]},{"href":"/en/webhooks/using-webhooks/disabling-webhooks","title":"Disable webhooks","childPages":[]},{"href":"/en/webhooks/using-webhooks/best-practices-for-using-webhooks","title":"Best practices","childPages":[]},{"href":"/en/webhooks/using-webhooks/handling-failed-webhook-deliveries","title":"Handle failed deliveries","childPages":[]},{"href":"/en/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-repository-webhook","title":"Automatically redeliver for repository","childPages":[]},{"href":"/en/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-an-organization-webhook","title":"Automatically redeliver for organization","childPages":[]},{"href":"/en/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-github-app-webhook","title":"Automatically redeliver for GitHub App","childPages":[]}]},{"href":"/en/webhooks/testing-and-troubleshooting-webhooks","title":"Testing and troubleshooting webhooks","childPages":[{"href":"/en/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries","title":"View deliveries","childPages":[]},{"href":"/en/webhooks/testing-and-troubleshooting-webhooks/redelivering-webhooks","title":"Redeliver webhooks","childPages":[]},{"href":"/en/webhooks/testing-and-troubleshooting-webhooks/testing-webhooks","title":"Test webhooks","childPages":[]},{"href":"/en/webhooks/testing-and-troubleshooting-webhooks/troubleshooting-webhooks","title":"Troubleshoot webhooks","childPages":[]},{"href":"/en/webhooks/testing-and-troubleshooting-webhooks/using-the-github-cli-to-forward-webhooks-for-testing","title":"Test with the CLI","childPages":[]}]}]},"featureFlags":{},"nonEnterpriseDefaultVersion":"free-pro-team@latest","status":200,"fullUrl":"https://docs-internal.github.com/en/webhooks/webhook-events-and-payloads","currentLayoutName":"default","relativePath":"webhooks/webhook-events-and-payloads.md"},"automatedPageContext":{"title":"Webhook events and payloads","intro":"\u003cp\u003eLearn about when each webhook event occurs and what the payload contains.\u003c/p\u003e","renderedPage":"\u003ch2 id=\"about-webhook-events-and-payloads\" tabindex=\"-1\"\u003e\u003ca class=\"heading-link\" href=\"#about-webhook-events-and-payloads\"\u003eAbout webhook events and payloads\u003cspan class=\"heading-link-symbol\" aria-hidden=\"true\"\u003e\u003c/span\u003e\u003c/a\u003e\u003c/h2\u003e\n\u003cp\u003eYou can create webhooks that subscribe to the events listed on this page. To limit the number of HTTP requests to your server, you should only subscribe to the specific events that you plan on handling. For more information, see \u003ca href=\"/en/webhooks/creating-webhooks\" _originalHref=\"/webhooks/creating-webhooks\"\u003eCreating webhooks\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eEach webhook event on this page includes a description of the webhook properties for that event. If the event has multiple actions, the properties corresponding to each action are included.\u003c/p\u003e\n\u003cp\u003eEach event is only available to specific types of webhooks. For example, an organization webhook can subscribe to the \u003ccode\u003eteam\u003c/code\u003e event, but a repository webhook cannot. The description of each webhook event lists the availability for that event. For more information, see \u003ca href=\"/en/webhooks/types-of-webhooks\" _originalHref=\"/webhooks/types-of-webhooks\"\u003eTypes of webhooks\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id=\"payload-cap\" tabindex=\"-1\"\u003e\u003ca class=\"heading-link\" href=\"#payload-cap\"\u003ePayload cap\u003cspan class=\"heading-link-symbol\" aria-hidden=\"true\"\u003e\u003c/span\u003e\u003c/a\u003e\u003c/h3\u003e\n\u003cp\u003ePayloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, on a \u003ccode\u003ecreate\u003c/code\u003e event if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.\u003c/p\u003e\n\u003ch3 id=\"delivery-headers\" tabindex=\"-1\"\u003e\u003ca class=\"heading-link\" href=\"#delivery-headers\"\u003eDelivery headers\u003cspan class=\"heading-link-symbol\" aria-hidden=\"true\"\u003e\u003c/span\u003e\u003c/a\u003e\u003c/h3\u003e\n\u003cp\u003eHTTP POST payloads that are delivered to your webhook's configured URL endpoint will contain several special headers:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ccode\u003eX-GitHub-Hook-ID\u003c/code\u003e: The unique identifier of the webhook.\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eX-GitHub-Event\u003c/code\u003e: The name of the event that triggered the delivery.\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eX-GitHub-Delivery\u003c/code\u003e: A globally unique identifier (GUID) to identify the event.\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eX-Hub-Signature\u003c/code\u003e: This header is sent if the webhook is configured with a \u003ccode\u003esecret\u003c/code\u003e. This is the HMAC hex digest of the request body, and is generated using the SHA-1 hash function and the \u003ccode\u003esecret\u003c/code\u003e as the HMAC \u003ccode\u003ekey\u003c/code\u003e. \u003ccode\u003eX-Hub-Signature\u003c/code\u003e is provided for compatibility with existing integrations. We recommend that you use the more secure \u003ccode\u003eX-Hub-Signature-256\u003c/code\u003e instead.\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eX-Hub-Signature-256\u003c/code\u003e: This header is sent if the webhook is configured with a \u003ccode\u003esecret\u003c/code\u003e. This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and the \u003ccode\u003esecret\u003c/code\u003e as the HMAC \u003ccode\u003ekey\u003c/code\u003e. For more information, see \u003ca href=\"/en/webhooks/using-webhooks/securing-your-webhooks\" _originalHref=\"/webhooks/using-webhooks/securing-your-webhooks\"\u003eValidating webhook deliveries\u003c/a\u003e.\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eUser-Agent\u003c/code\u003e: This header will always have the prefix \u003ccode\u003eGitHub-Hookshot/\u003c/code\u003e.\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eX-GitHub-Hook-Installation-Target-Type\u003c/code\u003e: The type of resource where the webhook was created.\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eX-GitHub-Hook-Installation-Target-ID\u003c/code\u003e: The unique identifier of the resource where the webhook was created.\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eTo see what each header might look like in a webhook payload, see \u003ca href=\"#example-webhook-delivery\"\u003eExample webhook delivery\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id=\"example-webhook-delivery\" tabindex=\"-1\"\u003e\u003ca class=\"heading-link\" href=\"#example-webhook-delivery\"\u003eExample webhook delivery\u003cspan class=\"heading-link-symbol\" aria-hidden=\"true\"\u003e\u003c/span\u003e\u003c/a\u003e\u003c/h3\u003e\n\u003cp\u003eYou can choose to have payloads delivered in JSON format (\u003ccode\u003eapplication/json\u003c/code\u003e) or as URL-encoded data (\u003ccode\u003ex-www-form-urlencoded\u003c/code\u003e). Following is an example of a webhook POST request that uses the JSON format.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class=\"hljs language-shell\"\u003e\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003ePOST /payload HTTP/1.1\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\n\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003eX-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003eX-Hub-Signature: sha1=7d38cdd689735b008b3c702edd92eea23791c5f6\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003eX-Hub-Signature-256: sha256=d57c68ca6f92289e6987922ff26938930f6e66a2d161ef06abdf1859230aa23c\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003eUser-Agent: GitHub-Hookshot/044aadd\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003eContent-Type: application/json\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003eContent-Length: 6615\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003eX-GitHub-Event: issues\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003eX-GitHub-Hook-ID: 292430182\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003eX-GitHub-Hook-Installation-Target-ID: 79929171\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003eX-GitHub-Hook-Installation-Target-Type: repository\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\n\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e{\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e \u003cspan class=\"hljs-string\"\u003e\"action\"\u003c/span\u003e: \u003cspan class=\"hljs-string\"\u003e\"opened\"\u003c/span\u003e,\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e \u003cspan class=\"hljs-string\"\u003e\"issue\"\u003c/span\u003e: {\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e \u003cspan class=\"hljs-string\"\u003e\"url\"\u003c/span\u003e: \u003cspan class=\"hljs-string\"\u003e\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"\u003c/span\u003e,\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e \u003cspan class=\"hljs-string\"\u003e\"number\"\u003c/span\u003e: 1347,\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e ...\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e },\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e \u003cspan class=\"hljs-string\"\u003e\"repository\"\u003c/span\u003e : {\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e \u003cspan class=\"hljs-string\"\u003e\"id\"\u003c/span\u003e: 1296269,\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e \u003cspan class=\"hljs-string\"\u003e\"full_name\"\u003c/span\u003e: \u003cspan class=\"hljs-string\"\u003e\"octocat/Hello-World\"\u003c/span\u003e,\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e \u003cspan class=\"hljs-string\"\u003e\"owner\"\u003c/span\u003e: {\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e \u003cspan class=\"hljs-string\"\u003e\"login\"\u003c/span\u003e: \u003cspan class=\"hljs-string\"\u003e\"octocat\"\u003c/span\u003e,\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e \u003cspan class=\"hljs-string\"\u003e\"id\"\u003c/span\u003e: 1,\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e ...\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e },\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e ...\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e },\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e \u003cspan class=\"hljs-string\"\u003e\"sender\"\u003c/span\u003e: {\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e \u003cspan class=\"hljs-string\"\u003e\"login\"\u003c/span\u003e: \u003cspan class=\"hljs-string\"\u003e\"octocat\"\u003c/span\u003e,\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e \u003cspan class=\"hljs-string\"\u003e\"id\"\u003c/span\u003e: 1,\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e ...\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e }\u003c/span\u003e\n\u003cspan class=\"hljs-meta prompt_\"\u003e\u003e \u003c/span\u003e\u003cspan class=\"bash\"\u003e}\u003c/span\u003e\n\u003c/code\u003e\u003c/pre\u003e","miniTocItems":[{"contents":{"href":"#about-webhook-events-and-payloads","title":"About webhook events and payloads"}},{"contents":{"href":"#branch_protection_configuration","title":"branch_protection_configuration"}},{"contents":{"href":"#branch_protection_rule","title":"branch_protection_rule"}},{"contents":{"href":"#check_run","title":"check_run"}},{"contents":{"href":"#check_suite","title":"check_suite"}},{"contents":{"href":"#code_scanning_alert","title":"code_scanning_alert"}},{"contents":{"href":"#commit_comment","title":"commit_comment"}},{"contents":{"href":"#create","title":"create"}},{"contents":{"href":"#custom_property","title":"custom_property"}},{"contents":{"href":"#custom_property_values","title":"custom_property_values"}},{"contents":{"href":"#delete","title":"delete"}},{"contents":{"href":"#dependabot_alert","title":"dependabot_alert"}},{"contents":{"href":"#deploy_key","title":"deploy_key"}},{"contents":{"href":"#deployment","title":"deployment"}},{"contents":{"href":"#deployment_protection_rule","title":"deployment_protection_rule"}},{"contents":{"href":"#deployment_review","title":"deployment_review"}},{"contents":{"href":"#deployment_status","title":"deployment_status"}},{"contents":{"href":"#discussion","title":"discussion"}},{"contents":{"href":"#discussion_comment","title":"discussion_comment"}},{"contents":{"href":"#fork","title":"fork"}},{"contents":{"href":"#github_app_authorization","title":"github_app_authorization"}},{"contents":{"href":"#gollum","title":"gollum"}},{"contents":{"href":"#installation","title":"installation"}},{"contents":{"href":"#installation_repositories","title":"installation_repositories"}},{"contents":{"href":"#installation_target","title":"installation_target"}},{"contents":{"href":"#issue_comment","title":"issue_comment"}},{"contents":{"href":"#issues","title":"issues"}},{"contents":{"href":"#label","title":"label"}},{"contents":{"href":"#marketplace_purchase","title":"marketplace_purchase"}},{"contents":{"href":"#member","title":"member"}},{"contents":{"href":"#membership","title":"membership"}},{"contents":{"href":"#merge_group","title":"merge_group"}},{"contents":{"href":"#meta","title":"meta"}},{"contents":{"href":"#milestone","title":"milestone"}},{"contents":{"href":"#org_block","title":"org_block"}},{"contents":{"href":"#organization","title":"organization"}},{"contents":{"href":"#package","title":"package"}},{"contents":{"href":"#page_build","title":"page_build"}},{"contents":{"href":"#personal_access_token_request","title":"personal_access_token_request"}},{"contents":{"href":"#ping","title":"ping"}},{"contents":{"href":"#project_card","title":"project_card"}},{"contents":{"href":"#project","title":"project"}},{"contents":{"href":"#project_column","title":"project_column"}},{"contents":{"href":"#projects_v2","title":"projects_v2"}},{"contents":{"href":"#projects_v2_item","title":"projects_v2_item"}},{"contents":{"href":"#projects_v2_status_update","title":"projects_v2_status_update"}},{"contents":{"href":"#public","title":"public"}},{"contents":{"href":"#pull_request","title":"pull_request"}},{"contents":{"href":"#pull_request_review_comment","title":"pull_request_review_comment"}},{"contents":{"href":"#pull_request_review","title":"pull_request_review"}},{"contents":{"href":"#pull_request_review_thread","title":"pull_request_review_thread"}},{"contents":{"href":"#push","title":"push"}},{"contents":{"href":"#registry_package","title":"registry_package"}},{"contents":{"href":"#release","title":"release"}},{"contents":{"href":"#repository_advisory","title":"repository_advisory"}},{"contents":{"href":"#repository","title":"repository"}},{"contents":{"href":"#repository_dispatch","title":"repository_dispatch"}},{"contents":{"href":"#repository_import","title":"repository_import"}},{"contents":{"href":"#repository_ruleset","title":"repository_ruleset"}},{"contents":{"href":"#repository_vulnerability_alert","title":"repository_vulnerability_alert"}},{"contents":{"href":"#secret_scanning_alert","title":"secret_scanning_alert"}},{"contents":{"href":"#secret_scanning_alert_location","title":"secret_scanning_alert_location"}},{"contents":{"href":"#secret_scanning_scan","title":"secret_scanning_scan"}},{"contents":{"href":"#security_advisory","title":"security_advisory"}},{"contents":{"href":"#security_and_analysis","title":"security_and_analysis"}},{"contents":{"href":"#sponsorship","title":"sponsorship"}},{"contents":{"href":"#star","title":"star"}},{"contents":{"href":"#status","title":"status"}},{"contents":{"href":"#sub_issues","title":"sub_issues"}},{"contents":{"href":"#team_add","title":"team_add"}},{"contents":{"href":"#team","title":"team"}},{"contents":{"href":"#watch","title":"watch"}},{"contents":{"href":"#workflow_dispatch","title":"workflow_dispatch"}},{"contents":{"href":"#workflow_job","title":"workflow_job"}},{"contents":{"href":"#workflow_run","title":"workflow_run"}}],"product":"","permissions":""}},"languagesContext":{"languages":{"en":{"name":"English","code":"en"},"zh":{"name":"Simplified Chinese","code":"zh","hreflang":"zh-Hans","nativeName":"简体中文"},"es":{"name":"Spanish","code":"es","nativeName":"Español"},"pt":{"name":"Portuguese","code":"pt","nativeName":"Português do Brasil"},"ru":{"name":"Russian","code":"ru","nativeName":"Русский"},"ja":{"name":"Japanese","code":"ja","nativeName":"日本語"},"fr":{"name":"French","code":"fr","nativeName":"Français"},"de":{"name":"German","code":"de","nativeName":"Deutsch"},"ko":{"name":"Korean","code":"ko","nativeName":"한국어"}}},"__N_SSP":true},"page":"/[versionId]/webhooks/webhook-events-and-payloads","query":{"versionId":"free-pro-team@latest"},"buildId":"7mRJ1xbGYF7vO0HMbUsiR","isFallback":false,"isExperimentalCompile":false,"gssp":true,"appGip":true,"locale":"en","locales":["en","zh","es","pt","ru","ja","fr","de","ko"],"defaultLocale":"en","scriptLoader":[]}</script></body></html>

Pages： 1 2 3 4 5 6 7 8 9 10