index.html 79 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="prev" href="../1password-automation/">
  7. <link rel="next" href="../fake/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.17">
  10. <title>Webhook - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.bcfcd587.min.css">
  12. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  13. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  14. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  15. <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  16. <script id="__analytics">function __md_analytics(){function n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){n("config","G-QP38TD8K7V",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
  17. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  18. </head>
  19. <body dir="ltr">
  20. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  21. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  22. <label class="md-overlay" for="__drawer"></label>
  23. <div data-md-component="skip">
  24. <a href="#generic-webhook" class="md-skip">
  25. Skip to content
  26. </a>
  27. </div>
  28. <div data-md-component="announce">
  29. </div>
  30. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  31. <aside class="md-banner md-banner--warning">
  32. <div class="md-banner__inner md-grid md-typeset">
  33. You're not viewing the latest version.
  34. <a href="../../..">
  35. <strong>Click here to go to latest.</strong>
  36. </a>
  37. </div>
  38. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  39. </aside>
  40. </div>
  41. <header class="md-header" data-md-component="header">
  42. <nav class="md-header__inner md-grid" aria-label="Header">
  43. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  44. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  45. </a>
  46. <label class="md-header__button md-icon" for="__drawer">
  47. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  48. </label>
  49. <div class="md-header__title" data-md-component="header-title">
  50. <div class="md-header__ellipsis">
  51. <div class="md-header__topic">
  52. <span class="md-ellipsis">
  53. External Secrets Operator
  54. </span>
  55. </div>
  56. <div class="md-header__topic" data-md-component="header-topic">
  57. <span class="md-ellipsis">
  58. Webhook
  59. </span>
  60. </div>
  61. </div>
  62. </div>
  63. <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  64. <label class="md-header__button md-icon" for="__search">
  65. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
  66. </label>
  67. <div class="md-search" data-md-component="search" role="dialog">
  68. <label class="md-search__overlay" for="__search"></label>
  69. <div class="md-search__inner" role="search">
  70. <form class="md-search__form" name="search">
  71. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  72. <label class="md-search__icon md-icon" for="__search">
  73. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
  74. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
  75. </label>
  76. <nav class="md-search__options" aria-label="Search">
  77. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  78. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
  79. </button>
  80. </nav>
  81. </form>
  82. <div class="md-search__output">
  83. <div class="md-search__scrollwrap" data-md-scrollfix>
  84. <div class="md-search-result" data-md-component="search-result">
  85. <div class="md-search-result__meta">
  86. Initializing search
  87. </div>
  88. <ol class="md-search-result__list" role="presentation"></ol>
  89. </div>
  90. </div>
  91. </div>
  92. </div>
  93. </div>
  94. <div class="md-header__source">
  95. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  96. <div class="md-source__icon md-icon">
  97. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  98. </div>
  99. <div class="md-source__repository">
  100. External Secrets Operator
  101. </div>
  102. </a>
  103. </div>
  104. </nav>
  105. </header>
  106. <div class="md-container" data-md-component="container">
  107. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  108. <div class="md-grid">
  109. <ul class="md-tabs__list">
  110. <li class="md-tabs__item">
  111. <a href="../.." class="md-tabs__link">
  112. Introduction
  113. </a>
  114. </li>
  115. <li class="md-tabs__item">
  116. <a href="../../api/components/" class="md-tabs__link">
  117. API
  118. </a>
  119. </li>
  120. <li class="md-tabs__item">
  121. <a href="../../guides/introduction/" class="md-tabs__link">
  122. Guides
  123. </a>
  124. </li>
  125. <li class="md-tabs__item md-tabs__item--active">
  126. <a href="../aws-secrets-manager/" class="md-tabs__link">
  127. Provider
  128. </a>
  129. </li>
  130. <li class="md-tabs__item">
  131. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  132. Examples
  133. </a>
  134. </li>
  135. <li class="md-tabs__item">
  136. <a href="../../contributing/devguide/" class="md-tabs__link">
  137. Community
  138. </a>
  139. </li>
  140. <li class="md-tabs__item">
  141. <a href="../../spec/" class="md-tabs__link">
  142. References
  143. </a>
  144. </li>
  145. <li class="md-tabs__item">
  146. <a href="../../contributing-devguide.md" class="md-tabs__link">
  147. Contributing
  148. </a>
  149. </li>
  150. <li class="md-tabs__item">
  151. <a href="../../deprecation-policy.md" class="md-tabs__link">
  152. Deprecation Policy
  153. </a>
  154. </li>
  155. </ul>
  156. </div>
  157. </nav>
  158. <main class="md-main" data-md-component="main">
  159. <div class="md-main__inner md-grid">
  160. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  161. <div class="md-sidebar__scrollwrap">
  162. <div class="md-sidebar__inner">
  163. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  164. <label class="md-nav__title" for="__drawer">
  165. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  166. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  167. </a>
  168. External Secrets Operator
  169. </label>
  170. <div class="md-nav__source">
  171. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  172. <div class="md-source__icon md-icon">
  173. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  174. </div>
  175. <div class="md-source__repository">
  176. External Secrets Operator
  177. </div>
  178. </a>
  179. </div>
  180. <ul class="md-nav__list" data-md-scrollfix>
  181. <li class="md-nav__item md-nav__item--nested">
  182. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  183. <div class="md-nav__link md-nav__container">
  184. <a href="../.." class="md-nav__link ">
  185. <span class="md-ellipsis">
  186. Introduction
  187. </span>
  188. </a>
  189. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  190. <span class="md-nav__icon md-icon"></span>
  191. </label>
  192. </div>
  193. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  194. <label class="md-nav__title" for="__nav_1">
  195. <span class="md-nav__icon md-icon"></span>
  196. Introduction
  197. </label>
  198. <ul class="md-nav__list" data-md-scrollfix>
  199. <li class="md-nav__item">
  200. <a href="../../introduction/overview/" class="md-nav__link">
  201. <span class="md-ellipsis">
  202. Overview
  203. </span>
  204. </a>
  205. </li>
  206. <li class="md-nav__item">
  207. <a href="../../introduction/getting-started/" class="md-nav__link">
  208. <span class="md-ellipsis">
  209. Getting started
  210. </span>
  211. </a>
  212. </li>
  213. <li class="md-nav__item">
  214. <a href="../../introduction/faq/" class="md-nav__link">
  215. <span class="md-ellipsis">
  216. FAQ
  217. </span>
  218. </a>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../../introduction/stability-support/" class="md-nav__link">
  222. <span class="md-ellipsis">
  223. Stability and Support
  224. </span>
  225. </a>
  226. </li>
  227. <li class="md-nav__item">
  228. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  229. <span class="md-ellipsis">
  230. Deprecation Policy
  231. </span>
  232. </a>
  233. </li>
  234. </ul>
  235. </nav>
  236. </li>
  237. <li class="md-nav__item md-nav__item--nested">
  238. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  239. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  240. <span class="md-ellipsis">
  241. API
  242. </span>
  243. <span class="md-nav__icon md-icon"></span>
  244. </label>
  245. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  246. <label class="md-nav__title" for="__nav_2">
  247. <span class="md-nav__icon md-icon"></span>
  248. API
  249. </label>
  250. <ul class="md-nav__list" data-md-scrollfix>
  251. <li class="md-nav__item">
  252. <a href="../../api/components/" class="md-nav__link">
  253. <span class="md-ellipsis">
  254. Components
  255. </span>
  256. </a>
  257. </li>
  258. <li class="md-nav__item md-nav__item--nested">
  259. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  260. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  261. <span class="md-ellipsis">
  262. Core Resources
  263. </span>
  264. <span class="md-nav__icon md-icon"></span>
  265. </label>
  266. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  267. <label class="md-nav__title" for="__nav_2_2">
  268. <span class="md-nav__icon md-icon"></span>
  269. Core Resources
  270. </label>
  271. <ul class="md-nav__list" data-md-scrollfix>
  272. <li class="md-nav__item">
  273. <a href="../../api/externalsecret/" class="md-nav__link">
  274. <span class="md-ellipsis">
  275. ExternalSecret
  276. </span>
  277. </a>
  278. </li>
  279. <li class="md-nav__item">
  280. <a href="../../api/secretstore/" class="md-nav__link">
  281. <span class="md-ellipsis">
  282. SecretStore
  283. </span>
  284. </a>
  285. </li>
  286. <li class="md-nav__item">
  287. <a href="../../api/clustersecretstore/" class="md-nav__link">
  288. <span class="md-ellipsis">
  289. ClusterSecretStore
  290. </span>
  291. </a>
  292. </li>
  293. <li class="md-nav__item">
  294. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  295. <span class="md-ellipsis">
  296. ClusterExternalSecret
  297. </span>
  298. </a>
  299. </li>
  300. <li class="md-nav__item">
  301. <a href="../../api/pushsecret/" class="md-nav__link">
  302. <span class="md-ellipsis">
  303. PushSecret
  304. </span>
  305. </a>
  306. </li>
  307. </ul>
  308. </nav>
  309. </li>
  310. <li class="md-nav__item md-nav__item--nested">
  311. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  312. <div class="md-nav__link md-nav__container">
  313. <a href="../../api/generator/" class="md-nav__link ">
  314. <span class="md-ellipsis">
  315. Generators
  316. </span>
  317. </a>
  318. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  319. <span class="md-nav__icon md-icon"></span>
  320. </label>
  321. </div>
  322. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  323. <label class="md-nav__title" for="__nav_2_3">
  324. <span class="md-nav__icon md-icon"></span>
  325. Generators
  326. </label>
  327. <ul class="md-nav__list" data-md-scrollfix>
  328. <li class="md-nav__item">
  329. <a href="../../api/generator/acr/" class="md-nav__link">
  330. <span class="md-ellipsis">
  331. Azure Container Registry
  332. </span>
  333. </a>
  334. </li>
  335. <li class="md-nav__item">
  336. <a href="../../api/generator/ecr/" class="md-nav__link">
  337. <span class="md-ellipsis">
  338. AWS Elastic Container Registry
  339. </span>
  340. </a>
  341. </li>
  342. <li class="md-nav__item">
  343. <a href="../../api/generator/gcr/" class="md-nav__link">
  344. <span class="md-ellipsis">
  345. Google Container Registry
  346. </span>
  347. </a>
  348. </li>
  349. <li class="md-nav__item">
  350. <a href="../../api/generator/vault/" class="md-nav__link">
  351. <span class="md-ellipsis">
  352. Vault Dynamic Secret
  353. </span>
  354. </a>
  355. </li>
  356. <li class="md-nav__item">
  357. <a href="../../api/generator/password/" class="md-nav__link">
  358. <span class="md-ellipsis">
  359. Password
  360. </span>
  361. </a>
  362. </li>
  363. <li class="md-nav__item">
  364. <a href="../../api/generator/fake/" class="md-nav__link">
  365. <span class="md-ellipsis">
  366. Fake
  367. </span>
  368. </a>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="../../api/generator/webhook/" class="md-nav__link">
  372. <span class="md-ellipsis">
  373. Webhook
  374. </span>
  375. </a>
  376. </li>
  377. </ul>
  378. </nav>
  379. </li>
  380. <li class="md-nav__item md-nav__item--nested">
  381. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  382. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  383. <span class="md-ellipsis">
  384. Reference Docs
  385. </span>
  386. <span class="md-nav__icon md-icon"></span>
  387. </label>
  388. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  389. <label class="md-nav__title" for="__nav_2_4">
  390. <span class="md-nav__icon md-icon"></span>
  391. Reference Docs
  392. </label>
  393. <ul class="md-nav__list" data-md-scrollfix>
  394. <li class="md-nav__item">
  395. <a href="../../api/spec/" class="md-nav__link">
  396. <span class="md-ellipsis">
  397. API specification
  398. </span>
  399. </a>
  400. </li>
  401. <li class="md-nav__item">
  402. <a href="../../api/controller-options/" class="md-nav__link">
  403. <span class="md-ellipsis">
  404. Controller Options
  405. </span>
  406. </a>
  407. </li>
  408. <li class="md-nav__item">
  409. <a href="../../api/metrics/" class="md-nav__link">
  410. <span class="md-ellipsis">
  411. Metrics
  412. </span>
  413. </a>
  414. </li>
  415. </ul>
  416. </nav>
  417. </li>
  418. </ul>
  419. </nav>
  420. </li>
  421. <li class="md-nav__item md-nav__item--nested">
  422. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  423. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  424. <span class="md-ellipsis">
  425. Guides
  426. </span>
  427. <span class="md-nav__icon md-icon"></span>
  428. </label>
  429. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  430. <label class="md-nav__title" for="__nav_3">
  431. <span class="md-nav__icon md-icon"></span>
  432. Guides
  433. </label>
  434. <ul class="md-nav__list" data-md-scrollfix>
  435. <li class="md-nav__item">
  436. <a href="../../guides/introduction/" class="md-nav__link">
  437. <span class="md-ellipsis">
  438. Introduction
  439. </span>
  440. </a>
  441. </li>
  442. <li class="md-nav__item md-nav__item--nested">
  443. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  444. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  445. <span class="md-ellipsis">
  446. External Secrets
  447. </span>
  448. <span class="md-nav__icon md-icon"></span>
  449. </label>
  450. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  451. <label class="md-nav__title" for="__nav_3_2">
  452. <span class="md-nav__icon md-icon"></span>
  453. External Secrets
  454. </label>
  455. <ul class="md-nav__list" data-md-scrollfix>
  456. <li class="md-nav__item">
  457. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  458. <span class="md-ellipsis">
  459. Extract structured data
  460. </span>
  461. </a>
  462. </li>
  463. <li class="md-nav__item">
  464. <a href="../../guides/getallsecrets/" class="md-nav__link">
  465. <span class="md-ellipsis">
  466. Find Secrets by Name or Metadata
  467. </span>
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  472. <span class="md-ellipsis">
  473. Rewriting Keys
  474. </span>
  475. </a>
  476. </li>
  477. <li class="md-nav__item md-nav__item--nested">
  478. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  479. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  480. <span class="md-ellipsis">
  481. Advanced Templating
  482. </span>
  483. <span class="md-nav__icon md-icon"></span>
  484. </label>
  485. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  486. <label class="md-nav__title" for="__nav_3_2_4">
  487. <span class="md-nav__icon md-icon"></span>
  488. Advanced Templating
  489. </label>
  490. <ul class="md-nav__list" data-md-scrollfix>
  491. <li class="md-nav__item">
  492. <a href="../../guides/templating/" class="md-nav__link">
  493. <span class="md-ellipsis">
  494. v2
  495. </span>
  496. </a>
  497. </li>
  498. <li class="md-nav__item">
  499. <a href="../../guides/templating-v1/" class="md-nav__link">
  500. <span class="md-ellipsis">
  501. v1
  502. </span>
  503. </a>
  504. </li>
  505. </ul>
  506. </nav>
  507. </li>
  508. <li class="md-nav__item">
  509. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  510. <span class="md-ellipsis">
  511. Kubernetes Secret Types
  512. </span>
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  517. <span class="md-ellipsis">
  518. Lifecycle: ownership & deletion
  519. </span>
  520. </a>
  521. </li>
  522. <li class="md-nav__item">
  523. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  524. <span class="md-ellipsis">
  525. Decoding Strategies
  526. </span>
  527. </a>
  528. </li>
  529. <li class="md-nav__item">
  530. <a href="../../guides/controller-class/" class="md-nav__link">
  531. <span class="md-ellipsis">
  532. Controller Classes
  533. </span>
  534. </a>
  535. </li>
  536. </ul>
  537. </nav>
  538. </li>
  539. <li class="md-nav__item">
  540. <a href="../../guides/generator/" class="md-nav__link">
  541. <span class="md-ellipsis">
  542. Generators
  543. </span>
  544. </a>
  545. </li>
  546. <li class="md-nav__item">
  547. <a href="../../guides/pushsecrets/" class="md-nav__link">
  548. <span class="md-ellipsis">
  549. Push Secrets
  550. </span>
  551. </a>
  552. </li>
  553. <li class="md-nav__item md-nav__item--nested">
  554. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  555. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  556. <span class="md-ellipsis">
  557. Operations
  558. </span>
  559. <span class="md-nav__icon md-icon"></span>
  560. </label>
  561. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  562. <label class="md-nav__title" for="__nav_3_5">
  563. <span class="md-nav__icon md-icon"></span>
  564. Operations
  565. </label>
  566. <ul class="md-nav__list" data-md-scrollfix>
  567. <li class="md-nav__item">
  568. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  569. <span class="md-ellipsis">
  570. Multi Tenancy
  571. </span>
  572. </a>
  573. </li>
  574. <li class="md-nav__item">
  575. <a href="../../guides/security-best-practices/" class="md-nav__link">
  576. <span class="md-ellipsis">
  577. Security Best Practices
  578. </span>
  579. </a>
  580. </li>
  581. <li class="md-nav__item">
  582. <a href="../../guides/threat-model/" class="md-nav__link">
  583. <span class="md-ellipsis">
  584. Threat Model
  585. </span>
  586. </a>
  587. </li>
  588. <li class="md-nav__item">
  589. <a href="../../guides/v1beta1/" class="md-nav__link">
  590. <span class="md-ellipsis">
  591. Upgrading to v1beta1
  592. </span>
  593. </a>
  594. </li>
  595. <li class="md-nav__item">
  596. <a href="../../guides/using-latest-image/" class="md-nav__link">
  597. <span class="md-ellipsis">
  598. Using Latest Image
  599. </span>
  600. </a>
  601. </li>
  602. <li class="md-nav__item">
  603. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  604. <span class="md-ellipsis">
  605. Disable Cluster Features
  606. </span>
  607. </a>
  608. </li>
  609. </ul>
  610. </nav>
  611. </li>
  612. </ul>
  613. </nav>
  614. </li>
  615. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  616. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
  617. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
  618. <span class="md-ellipsis">
  619. Provider
  620. </span>
  621. <span class="md-nav__icon md-icon"></span>
  622. </label>
  623. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
  624. <label class="md-nav__title" for="__nav_4">
  625. <span class="md-nav__icon md-icon"></span>
  626. Provider
  627. </label>
  628. <ul class="md-nav__list" data-md-scrollfix>
  629. <li class="md-nav__item">
  630. <a href="../aws-secrets-manager/" class="md-nav__link">
  631. <span class="md-ellipsis">
  632. AWS Secrets Manager
  633. </span>
  634. </a>
  635. </li>
  636. <li class="md-nav__item">
  637. <a href="../aws-parameter-store/" class="md-nav__link">
  638. <span class="md-ellipsis">
  639. AWS Parameter Store
  640. </span>
  641. </a>
  642. </li>
  643. <li class="md-nav__item">
  644. <a href="../azure-key-vault/" class="md-nav__link">
  645. <span class="md-ellipsis">
  646. Azure Key Vault
  647. </span>
  648. </a>
  649. </li>
  650. <li class="md-nav__item">
  651. <a href="../chef/" class="md-nav__link">
  652. <span class="md-ellipsis">
  653. Chef
  654. </span>
  655. </a>
  656. </li>
  657. <li class="md-nav__item">
  658. <a href="../conjur/" class="md-nav__link">
  659. <span class="md-ellipsis">
  660. CyberArk Conjur
  661. </span>
  662. </a>
  663. </li>
  664. <li class="md-nav__item">
  665. <a href="../google-secrets-manager/" class="md-nav__link">
  666. <span class="md-ellipsis">
  667. Google Cloud Secret Manager
  668. </span>
  669. </a>
  670. </li>
  671. <li class="md-nav__item">
  672. <a href="../hashicorp-vault/" class="md-nav__link">
  673. <span class="md-ellipsis">
  674. HashiCorp Vault
  675. </span>
  676. </a>
  677. </li>
  678. <li class="md-nav__item">
  679. <a href="../kubernetes/" class="md-nav__link">
  680. <span class="md-ellipsis">
  681. Kubernetes
  682. </span>
  683. </a>
  684. </li>
  685. <li class="md-nav__item">
  686. <a href="../ibm-secrets-manager/" class="md-nav__link">
  687. <span class="md-ellipsis">
  688. IBM Secrets Manager
  689. </span>
  690. </a>
  691. </li>
  692. <li class="md-nav__item">
  693. <a href="../akeyless/" class="md-nav__link">
  694. <span class="md-ellipsis">
  695. Akeyless
  696. </span>
  697. </a>
  698. </li>
  699. <li class="md-nav__item">
  700. <a href="../yandex-certificate-manager/" class="md-nav__link">
  701. <span class="md-ellipsis">
  702. Yandex Certificate Manager
  703. </span>
  704. </a>
  705. </li>
  706. <li class="md-nav__item">
  707. <a href="../yandex-lockbox/" class="md-nav__link">
  708. <span class="md-ellipsis">
  709. Yandex Lockbox
  710. </span>
  711. </a>
  712. </li>
  713. <li class="md-nav__item">
  714. <a href="../alibaba/" class="md-nav__link">
  715. <span class="md-ellipsis">
  716. Alibaba Cloud
  717. </span>
  718. </a>
  719. </li>
  720. <li class="md-nav__item">
  721. <a href="../gitlab-variables/" class="md-nav__link">
  722. <span class="md-ellipsis">
  723. GitLab Variables
  724. </span>
  725. </a>
  726. </li>
  727. <li class="md-nav__item">
  728. <a href="../oracle-vault/" class="md-nav__link">
  729. <span class="md-ellipsis">
  730. Oracle Vault
  731. </span>
  732. </a>
  733. </li>
  734. <li class="md-nav__item">
  735. <a href="../1password-automation/" class="md-nav__link">
  736. <span class="md-ellipsis">
  737. 1Password Secrets Automation
  738. </span>
  739. </a>
  740. </li>
  741. <li class="md-nav__item md-nav__item--active">
  742. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  743. <label class="md-nav__link md-nav__link--active" for="__toc">
  744. <span class="md-ellipsis">
  745. Webhook
  746. </span>
  747. <span class="md-nav__icon md-icon"></span>
  748. </label>
  749. <a href="./" class="md-nav__link md-nav__link--active">
  750. <span class="md-ellipsis">
  751. Webhook
  752. </span>
  753. </a>
  754. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  755. <label class="md-nav__title" for="__toc">
  756. <span class="md-nav__icon md-icon"></span>
  757. Table of contents
  758. </label>
  759. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  760. <li class="md-nav__item">
  761. <a href="#generic-webhook" class="md-nav__link">
  762. <span class="md-ellipsis">
  763. Generic Webhook
  764. </span>
  765. </a>
  766. <nav class="md-nav" aria-label="Generic Webhook">
  767. <ul class="md-nav__list">
  768. <li class="md-nav__item">
  769. <a href="#example" class="md-nav__link">
  770. <span class="md-ellipsis">
  771. Example
  772. </span>
  773. </a>
  774. <nav class="md-nav" aria-label="Example">
  775. <ul class="md-nav__list">
  776. <li class="md-nav__item">
  777. <a href="#limitations" class="md-nav__link">
  778. <span class="md-ellipsis">
  779. Limitations
  780. </span>
  781. </a>
  782. </li>
  783. </ul>
  784. </nav>
  785. </li>
  786. <li class="md-nav__item">
  787. <a href="#templating" class="md-nav__link">
  788. <span class="md-ellipsis">
  789. Templating
  790. </span>
  791. </a>
  792. </li>
  793. <li class="md-nav__item">
  794. <a href="#all-parameters" class="md-nav__link">
  795. <span class="md-ellipsis">
  796. All Parameters
  797. </span>
  798. </a>
  799. </li>
  800. <li class="md-nav__item">
  801. <a href="#webhook-as-generators" class="md-nav__link">
  802. <span class="md-ellipsis">
  803. Webhook as generators
  804. </span>
  805. </a>
  806. </li>
  807. </ul>
  808. </nav>
  809. </li>
  810. </ul>
  811. </nav>
  812. </li>
  813. <li class="md-nav__item">
  814. <a href="../fake/" class="md-nav__link">
  815. <span class="md-ellipsis">
  816. Fake
  817. </span>
  818. </a>
  819. </li>
  820. <li class="md-nav__item">
  821. <a href="../senhasegura-dsm/" class="md-nav__link">
  822. <span class="md-ellipsis">
  823. senhasegura DevOps Secrets Management (DSM)
  824. </span>
  825. </a>
  826. </li>
  827. <li class="md-nav__item">
  828. <a href="../doppler/" class="md-nav__link">
  829. <span class="md-ellipsis">
  830. Doppler
  831. </span>
  832. </a>
  833. </li>
  834. <li class="md-nav__item">
  835. <a href="../keeper-security/" class="md-nav__link">
  836. <span class="md-ellipsis">
  837. Keeper Security
  838. </span>
  839. </a>
  840. </li>
  841. <li class="md-nav__item">
  842. <a href="../cloak/" class="md-nav__link">
  843. <span class="md-ellipsis">
  844. Cloak End 2 End Encrypted Secrets
  845. </span>
  846. </a>
  847. </li>
  848. <li class="md-nav__item">
  849. <a href="../scaleway/" class="md-nav__link">
  850. <span class="md-ellipsis">
  851. Scaleway
  852. </span>
  853. </a>
  854. </li>
  855. <li class="md-nav__item">
  856. <a href="../delinea/" class="md-nav__link">
  857. <span class="md-ellipsis">
  858. Delinea
  859. </span>
  860. </a>
  861. </li>
  862. <li class="md-nav__item">
  863. <a href="../passbolt/" class="md-nav__link">
  864. <span class="md-ellipsis">
  865. Passbolt
  866. </span>
  867. </a>
  868. </li>
  869. <li class="md-nav__item">
  870. <a href="../pulumi/" class="md-nav__link">
  871. <span class="md-ellipsis">
  872. Pulumi ESC
  873. </span>
  874. </a>
  875. </li>
  876. <li class="md-nav__item">
  877. <a href="../onboardbase/" class="md-nav__link">
  878. <span class="md-ellipsis">
  879. Onboardbase
  880. </span>
  881. </a>
  882. </li>
  883. </ul>
  884. </nav>
  885. </li>
  886. <li class="md-nav__item md-nav__item--nested">
  887. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  888. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  889. <span class="md-ellipsis">
  890. Examples
  891. </span>
  892. <span class="md-nav__icon md-icon"></span>
  893. </label>
  894. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  895. <label class="md-nav__title" for="__nav_5">
  896. <span class="md-nav__icon md-icon"></span>
  897. Examples
  898. </label>
  899. <ul class="md-nav__list" data-md-scrollfix>
  900. <li class="md-nav__item">
  901. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  902. <span class="md-ellipsis">
  903. FluxCD
  904. </span>
  905. </a>
  906. </li>
  907. <li class="md-nav__item">
  908. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  909. <span class="md-ellipsis">
  910. Anchore Engine
  911. </span>
  912. </a>
  913. </li>
  914. <li class="md-nav__item">
  915. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  916. <span class="md-ellipsis">
  917. Jenkins
  918. </span>
  919. </a>
  920. </li>
  921. <li class="md-nav__item">
  922. <a href="../../examples/bitwarden/" class="md-nav__link">
  923. <span class="md-ellipsis">
  924. BitWarden
  925. </span>
  926. </a>
  927. </li>
  928. </ul>
  929. </nav>
  930. </li>
  931. <li class="md-nav__item md-nav__item--nested">
  932. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  933. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  934. <span class="md-ellipsis">
  935. Community
  936. </span>
  937. <span class="md-nav__icon md-icon"></span>
  938. </label>
  939. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  940. <label class="md-nav__title" for="__nav_6">
  941. <span class="md-nav__icon md-icon"></span>
  942. Community
  943. </label>
  944. <ul class="md-nav__list" data-md-scrollfix>
  945. <li class="md-nav__item md-nav__item--nested">
  946. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  947. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  948. <span class="md-ellipsis">
  949. Contributing
  950. </span>
  951. <span class="md-nav__icon md-icon"></span>
  952. </label>
  953. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  954. <label class="md-nav__title" for="__nav_6_1">
  955. <span class="md-nav__icon md-icon"></span>
  956. Contributing
  957. </label>
  958. <ul class="md-nav__list" data-md-scrollfix>
  959. <li class="md-nav__item">
  960. <a href="../../contributing/devguide/" class="md-nav__link">
  961. <span class="md-ellipsis">
  962. Developer guide
  963. </span>
  964. </a>
  965. </li>
  966. <li class="md-nav__item">
  967. <a href="../../contributing/process/" class="md-nav__link">
  968. <span class="md-ellipsis">
  969. Contributing Process
  970. </span>
  971. </a>
  972. </li>
  973. <li class="md-nav__item">
  974. <a href="../../contributing/release/" class="md-nav__link">
  975. <span class="md-ellipsis">
  976. Release Process
  977. </span>
  978. </a>
  979. </li>
  980. <li class="md-nav__item">
  981. <a href="../../contributing/coc/" class="md-nav__link">
  982. <span class="md-ellipsis">
  983. Code of Conduct
  984. </span>
  985. </a>
  986. </li>
  987. <li class="md-nav__item">
  988. <a href="../../contributing/roadmap/" class="md-nav__link">
  989. <span class="md-ellipsis">
  990. Roadmap
  991. </span>
  992. </a>
  993. </li>
  994. </ul>
  995. </nav>
  996. </li>
  997. <li class="md-nav__item md-nav__item--nested">
  998. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  999. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1000. <span class="md-ellipsis">
  1001. External Resources
  1002. </span>
  1003. <span class="md-nav__icon md-icon"></span>
  1004. </label>
  1005. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1006. <label class="md-nav__title" for="__nav_6_2">
  1007. <span class="md-nav__icon md-icon"></span>
  1008. External Resources
  1009. </label>
  1010. <ul class="md-nav__list" data-md-scrollfix>
  1011. <li class="md-nav__item">
  1012. <a href="../../eso-talks/" class="md-nav__link">
  1013. <span class="md-ellipsis">
  1014. Talks
  1015. </span>
  1016. </a>
  1017. </li>
  1018. <li class="md-nav__item">
  1019. <a href="../../eso-demos/" class="md-nav__link">
  1020. <span class="md-ellipsis">
  1021. Demos
  1022. </span>
  1023. </a>
  1024. </li>
  1025. <li class="md-nav__item">
  1026. <a href="../../eso-blogs/" class="md-nav__link">
  1027. <span class="md-ellipsis">
  1028. Blogs
  1029. </span>
  1030. </a>
  1031. </li>
  1032. </ul>
  1033. </nav>
  1034. </li>
  1035. <li class="md-nav__item md-nav__item--nested">
  1036. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_3" >
  1037. <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
  1038. <span class="md-ellipsis">
  1039. AWS
  1040. </span>
  1041. <span class="md-nav__icon md-icon"></span>
  1042. </label>
  1043. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
  1044. <label class="md-nav__title" for="__nav_6_3">
  1045. <span class="md-nav__icon md-icon"></span>
  1046. AWS
  1047. </label>
  1048. <ul class="md-nav__list" data-md-scrollfix>
  1049. <li class="md-nav__item">
  1050. <a href="../../provider-aws-secrets-manager.md" class="md-nav__link">
  1051. <span class="md-ellipsis">
  1052. Secrets Manager
  1053. </span>
  1054. </a>
  1055. </li>
  1056. <li class="md-nav__item">
  1057. <a href="../../provider-aws-parameter-store.md" class="md-nav__link">
  1058. <span class="md-ellipsis">
  1059. Parameter Store
  1060. </span>
  1061. </a>
  1062. </li>
  1063. </ul>
  1064. </nav>
  1065. </li>
  1066. <li class="md-nav__item md-nav__item--nested">
  1067. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_4" >
  1068. <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
  1069. <span class="md-ellipsis">
  1070. Azure
  1071. </span>
  1072. <span class="md-nav__icon md-icon"></span>
  1073. </label>
  1074. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
  1075. <label class="md-nav__title" for="__nav_6_4">
  1076. <span class="md-nav__icon md-icon"></span>
  1077. Azure
  1078. </label>
  1079. <ul class="md-nav__list" data-md-scrollfix>
  1080. <li class="md-nav__item">
  1081. <a href="../../provider-azure-key-vault.md" class="md-nav__link">
  1082. <span class="md-ellipsis">
  1083. Key Vault
  1084. </span>
  1085. </a>
  1086. </li>
  1087. </ul>
  1088. </nav>
  1089. </li>
  1090. <li class="md-nav__item md-nav__item--nested">
  1091. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_5" >
  1092. <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
  1093. <span class="md-ellipsis">
  1094. Google
  1095. </span>
  1096. <span class="md-nav__icon md-icon"></span>
  1097. </label>
  1098. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
  1099. <label class="md-nav__title" for="__nav_6_5">
  1100. <span class="md-nav__icon md-icon"></span>
  1101. Google
  1102. </label>
  1103. <ul class="md-nav__list" data-md-scrollfix>
  1104. <li class="md-nav__item">
  1105. <a href="../../provider-google-secrets-manager.md" class="md-nav__link">
  1106. <span class="md-ellipsis">
  1107. Secrets Manager
  1108. </span>
  1109. </a>
  1110. </li>
  1111. </ul>
  1112. </nav>
  1113. </li>
  1114. <li class="md-nav__item md-nav__item--nested">
  1115. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_6" >
  1116. <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
  1117. <span class="md-ellipsis">
  1118. IBM
  1119. </span>
  1120. <span class="md-nav__icon md-icon"></span>
  1121. </label>
  1122. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
  1123. <label class="md-nav__title" for="__nav_6_6">
  1124. <span class="md-nav__icon md-icon"></span>
  1125. IBM
  1126. </label>
  1127. <ul class="md-nav__list" data-md-scrollfix>
  1128. <li class="md-nav__item">
  1129. <a href="../../provider-ibm-secrets-manager.md" class="md-nav__link">
  1130. <span class="md-ellipsis">
  1131. Secrets Manager
  1132. </span>
  1133. </a>
  1134. </li>
  1135. </ul>
  1136. </nav>
  1137. </li>
  1138. <li class="md-nav__item">
  1139. <a href="../../provider-hashicorp-vault.md" class="md-nav__link">
  1140. <span class="md-ellipsis">
  1141. HashiCorp Vault
  1142. </span>
  1143. </a>
  1144. </li>
  1145. <li class="md-nav__item md-nav__item--nested">
  1146. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_8" >
  1147. <label class="md-nav__link" for="__nav_6_8" id="__nav_6_8_label" tabindex="0">
  1148. <span class="md-ellipsis">
  1149. Yandex
  1150. </span>
  1151. <span class="md-nav__icon md-icon"></span>
  1152. </label>
  1153. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_8_label" aria-expanded="false">
  1154. <label class="md-nav__title" for="__nav_6_8">
  1155. <span class="md-nav__icon md-icon"></span>
  1156. Yandex
  1157. </label>
  1158. <ul class="md-nav__list" data-md-scrollfix>
  1159. <li class="md-nav__item">
  1160. <a href="../../provider-yandex-lockbox.md" class="md-nav__link">
  1161. <span class="md-ellipsis">
  1162. Lockbox
  1163. </span>
  1164. </a>
  1165. </li>
  1166. </ul>
  1167. </nav>
  1168. </li>
  1169. <li class="md-nav__item">
  1170. <a href="../../provider-passworddepot/" class="md-nav__link">
  1171. <span class="md-ellipsis">
  1172. Password Depot
  1173. </span>
  1174. </a>
  1175. </li>
  1176. <li class="md-nav__item md-nav__item--nested">
  1177. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_10" >
  1178. <label class="md-nav__link" for="__nav_6_10" id="__nav_6_10_label" tabindex="0">
  1179. <span class="md-ellipsis">
  1180. Gitlab
  1181. </span>
  1182. <span class="md-nav__icon md-icon"></span>
  1183. </label>
  1184. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_10_label" aria-expanded="false">
  1185. <label class="md-nav__title" for="__nav_6_10">
  1186. <span class="md-nav__icon md-icon"></span>
  1187. Gitlab
  1188. </label>
  1189. <ul class="md-nav__list" data-md-scrollfix>
  1190. <li class="md-nav__item">
  1191. <a href="../../provider-gitlab-project-variables.md" class="md-nav__link">
  1192. <span class="md-ellipsis">
  1193. Gitlab Project Variables
  1194. </span>
  1195. </a>
  1196. </li>
  1197. </ul>
  1198. </nav>
  1199. </li>
  1200. <li class="md-nav__item md-nav__item--nested">
  1201. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_11" >
  1202. <label class="md-nav__link" for="__nav_6_11" id="__nav_6_11_label" tabindex="0">
  1203. <span class="md-ellipsis">
  1204. Oracle
  1205. </span>
  1206. <span class="md-nav__icon md-icon"></span>
  1207. </label>
  1208. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_11_label" aria-expanded="false">
  1209. <label class="md-nav__title" for="__nav_6_11">
  1210. <span class="md-nav__icon md-icon"></span>
  1211. Oracle
  1212. </label>
  1213. <ul class="md-nav__list" data-md-scrollfix>
  1214. <li class="md-nav__item">
  1215. <a href="../../provider-oracle-vault.md" class="md-nav__link">
  1216. <span class="md-ellipsis">
  1217. Oracle Vault
  1218. </span>
  1219. </a>
  1220. </li>
  1221. </ul>
  1222. </nav>
  1223. </li>
  1224. </ul>
  1225. </nav>
  1226. </li>
  1227. <li class="md-nav__item md-nav__item--nested">
  1228. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
  1229. <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
  1230. <span class="md-ellipsis">
  1231. References
  1232. </span>
  1233. <span class="md-nav__icon md-icon"></span>
  1234. </label>
  1235. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
  1236. <label class="md-nav__title" for="__nav_7">
  1237. <span class="md-nav__icon md-icon"></span>
  1238. References
  1239. </label>
  1240. <ul class="md-nav__list" data-md-scrollfix>
  1241. <li class="md-nav__item">
  1242. <a href="../../spec/" class="md-nav__link">
  1243. <span class="md-ellipsis">
  1244. API specification
  1245. </span>
  1246. </a>
  1247. </li>
  1248. </ul>
  1249. </nav>
  1250. </li>
  1251. <li class="md-nav__item md-nav__item--nested">
  1252. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
  1253. <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
  1254. <span class="md-ellipsis">
  1255. Contributing
  1256. </span>
  1257. <span class="md-nav__icon md-icon"></span>
  1258. </label>
  1259. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
  1260. <label class="md-nav__title" for="__nav_8">
  1261. <span class="md-nav__icon md-icon"></span>
  1262. Contributing
  1263. </label>
  1264. <ul class="md-nav__list" data-md-scrollfix>
  1265. <li class="md-nav__item">
  1266. <a href="../../contributing-devguide.md" class="md-nav__link">
  1267. <span class="md-ellipsis">
  1268. Developer guide
  1269. </span>
  1270. </a>
  1271. </li>
  1272. <li class="md-nav__item">
  1273. <a href="../../contributing-process.md" class="md-nav__link">
  1274. <span class="md-ellipsis">
  1275. Contributing Process
  1276. </span>
  1277. </a>
  1278. </li>
  1279. <li class="md-nav__item">
  1280. <a href="../../contributing-coc.md" class="md-nav__link">
  1281. <span class="md-ellipsis">
  1282. Code of Conduct
  1283. </span>
  1284. </a>
  1285. </li>
  1286. </ul>
  1287. </nav>
  1288. </li>
  1289. <li class="md-nav__item">
  1290. <a href="../../deprecation-policy.md" class="md-nav__link">
  1291. <span class="md-ellipsis">
  1292. Deprecation Policy
  1293. </span>
  1294. </a>
  1295. </li>
  1296. </ul>
  1297. </nav>
  1298. </div>
  1299. </div>
  1300. </div>
  1301. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1302. <div class="md-sidebar__scrollwrap">
  1303. <div class="md-sidebar__inner">
  1304. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1305. <label class="md-nav__title" for="__toc">
  1306. <span class="md-nav__icon md-icon"></span>
  1307. Table of contents
  1308. </label>
  1309. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1310. <li class="md-nav__item">
  1311. <a href="#generic-webhook" class="md-nav__link">
  1312. <span class="md-ellipsis">
  1313. Generic Webhook
  1314. </span>
  1315. </a>
  1316. <nav class="md-nav" aria-label="Generic Webhook">
  1317. <ul class="md-nav__list">
  1318. <li class="md-nav__item">
  1319. <a href="#example" class="md-nav__link">
  1320. <span class="md-ellipsis">
  1321. Example
  1322. </span>
  1323. </a>
  1324. <nav class="md-nav" aria-label="Example">
  1325. <ul class="md-nav__list">
  1326. <li class="md-nav__item">
  1327. <a href="#limitations" class="md-nav__link">
  1328. <span class="md-ellipsis">
  1329. Limitations
  1330. </span>
  1331. </a>
  1332. </li>
  1333. </ul>
  1334. </nav>
  1335. </li>
  1336. <li class="md-nav__item">
  1337. <a href="#templating" class="md-nav__link">
  1338. <span class="md-ellipsis">
  1339. Templating
  1340. </span>
  1341. </a>
  1342. </li>
  1343. <li class="md-nav__item">
  1344. <a href="#all-parameters" class="md-nav__link">
  1345. <span class="md-ellipsis">
  1346. All Parameters
  1347. </span>
  1348. </a>
  1349. </li>
  1350. <li class="md-nav__item">
  1351. <a href="#webhook-as-generators" class="md-nav__link">
  1352. <span class="md-ellipsis">
  1353. Webhook as generators
  1354. </span>
  1355. </a>
  1356. </li>
  1357. </ul>
  1358. </nav>
  1359. </li>
  1360. </ul>
  1361. </nav>
  1362. </div>
  1363. </div>
  1364. </div>
  1365. <div class="md-content" data-md-component="content">
  1366. <article class="md-content__inner md-typeset">
  1367. <h1>Webhook</h1>
  1368. <h2 id="generic-webhook">Generic Webhook</h2>
  1369. <p>External Secrets Operator can integrate with simple web apis by specifying the endpoint</p>
  1370. <h3 id="example">Example</h3>
  1371. <p>First, create a SecretStore with a webhook backend. We'll use a static user/password <code>root</code>:</p>
  1372. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  1373. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1374. <span class="nt">metadata</span><span class="p">:</span>
  1375. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">webhook-backend</span>
  1376. <span class="nt">spec</span><span class="p">:</span>
  1377. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1378. <span class="w"> </span><span class="nt">webhook</span><span class="p">:</span>
  1379. <span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://httpbin.org/get?parameter={{</span><span class="nv"> </span><span class="s">.remoteRef.key</span><span class="nv"> </span><span class="s">}}&quot;</span>
  1380. <span class="w"> </span><span class="nt">result</span><span class="p">:</span>
  1381. <span class="w"> </span><span class="nt">jsonPath</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;$.args.parameter&quot;</span>
  1382. <span class="w"> </span><span class="nt">headers</span><span class="p">:</span>
  1383. <span class="w"> </span><span class="nt">Content-Type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">application/json</span>
  1384. <span class="w"> </span><span class="nt">Authorization</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Basic {{ print .auth.username &quot;:&quot; .auth.password | b64enc }}</span>
  1385. <span class="w"> </span><span class="nt">secrets</span><span class="p">:</span>
  1386. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">auth</span>
  1387. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1388. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">webhook-credentials</span>
  1389. <span class="nn">---</span>
  1390. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span>
  1391. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span>
  1392. <span class="nt">metadata</span><span class="p">:</span>
  1393. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">webhook-credentials</span>
  1394. <span class="nt">data</span><span class="p">:</span>
  1395. <span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dGVzdA==</span><span class="w"> </span><span class="c1"># &quot;test&quot;</span>
  1396. <span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dGVzdA==</span><span class="w"> </span><span class="c1"># &quot;test&quot;</span>
  1397. </code></pre></div>
  1398. <p>NB: This is obviously not practical because it just returns the key as the result, but it shows how it works</p>
  1399. <p><strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> in all <code>secrets</code> references with the namespaces where the secrets reside.</p>
  1400. <p>Now create an ExternalSecret that uses the above SecretStore:</p>
  1401. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  1402. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1403. <span class="nt">metadata</span><span class="p">:</span>
  1404. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">webhook-example</span>
  1405. <span class="nt">spec</span><span class="p">:</span>
  1406. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;15s&quot;</span>
  1407. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1408. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">webhook-backend</span>
  1409. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1410. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1411. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example-sync</span>
  1412. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1413. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">foobar</span>
  1414. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1415. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret</span>
  1416. <span class="nn">---</span>
  1417. <span class="c1"># will create a secret with:</span>
  1418. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span>
  1419. <span class="nt">metadata</span><span class="p">:</span>
  1420. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example-sync</span>
  1421. <span class="nt">data</span><span class="p">:</span>
  1422. <span class="w"> </span><span class="nt">foobar</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">c2VjcmV0</span>
  1423. </code></pre></div>
  1424. <h4 id="limitations">Limitations</h4>
  1425. <p>Webhook does not support authorization, other than what can be sent by generating http headers</p>
  1426. <div class="admonition note">
  1427. <p class="admonition-title">Note</p>
  1428. <p>If a webhook endpoint for a given <code>ExternalSecret</code> returns a 404 status code, the secret is considered to have been deleted. This will trigger the <code>deletionPolicy</code> set on the <code>ExternalSecret</code>.</p>
  1429. </div>
  1430. <h3 id="templating">Templating</h3>
  1431. <p>Generic WebHook provider uses the templating engine to generate the API call. It can be used in the url, headers, body and result.jsonPath fields.</p>
  1432. <p>The provider inserts the secret to be retrieved in the object named <code>remoteRef</code>.</p>
  1433. <p>In addition, secrets can be added as named objects, for example to use in authorization headers.
  1434. Each secret has a <code>name</code> property which determines the name of the object in the templating engine.</p>
  1435. <h3 id="all-parameters">All Parameters</h3>
  1436. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  1437. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span>
  1438. <span class="nt">metadata</span><span class="p">:</span>
  1439. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">statervault</span>
  1440. <span class="nt">spec</span><span class="p">:</span>
  1441. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1442. <span class="w"> </span><span class="nt">webhook</span><span class="p">:</span>
  1443. <span class="w"> </span><span class="c1"># Url to call. Use templating engine to fill in the request parameters</span>
  1444. <span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;url&gt;</span>
  1445. <span class="w"> </span><span class="c1"># http method, defaults to GET</span>
  1446. <span class="w"> </span><span class="nt">method</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;method&gt;</span>
  1447. <span class="w"> </span><span class="c1"># Timeout in duration (1s, 1m, etc)</span>
  1448. <span class="w"> </span><span class="nt">timeout</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1s</span>
  1449. <span class="w"> </span><span class="nt">result</span><span class="p">:</span>
  1450. <span class="w"> </span><span class="c1"># [jsonPath](https://jsonpath.com) syntax, which also can be templated</span>
  1451. <span class="w"> </span><span class="nt">jsonPath</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;jsonPath&gt;</span>
  1452. <span class="w"> </span><span class="c1"># Map of headers, can be templated</span>
  1453. <span class="w"> </span><span class="nt">headers</span><span class="p">:</span>
  1454. <span class="w"> </span><span class="nt">&lt;Header-Name&gt;</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;header contents&gt;</span>
  1455. <span class="w"> </span><span class="c1"># Body to sent as request, can be templated (optional)</span>
  1456. <span class="w"> </span><span class="nt">body</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;body&gt;</span>
  1457. <span class="w"> </span><span class="c1"># List of secrets to expose to the templating engine</span>
  1458. <span class="w"> </span><span class="nt">secrets</span><span class="p">:</span>
  1459. <span class="w"> </span><span class="c1"># Use this name to refer to this secret in templating, above</span>
  1460. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;name&gt;</span>
  1461. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1462. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;namespace&gt;</span><span class="w"> </span><span class="c1"># Only used in ClusterSecretStores</span>
  1463. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;name&gt;</span>
  1464. <span class="w"> </span><span class="c1"># Add CAs here for the TLS handshake</span>
  1465. <span class="w"> </span><span class="nt">caBundle</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;base64 encoded cabundle&gt;</span>
  1466. <span class="w"> </span><span class="nt">caProvider</span><span class="p">:</span>
  1467. <span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret or COnfigMap</span>
  1468. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;name of secret or configmap&gt;</span>
  1469. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;namespace&gt;</span><span class="w"> </span><span class="c1"># Only used in ClusterSecretStores</span>
  1470. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;key inside secret&gt;</span>
  1471. </code></pre></div>
  1472. <h3 id="webhook-as-generators">Webhook as generators</h3>
  1473. <p>You can also leverage webhooks as generators, following the same syntax. The only difference is that the webhook generator needs its source secrets to be labeled, as opposed to webhook secretstores. Please see the <a href="../../api/generator/webhook/">generator-webhook</a> documentation for more information. </p>
  1474. </article>
  1475. </div>
  1476. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1477. </div>
  1478. </main>
  1479. <footer class="md-footer">
  1480. <div class="md-footer-meta md-typeset">
  1481. <div class="md-footer-meta__inner md-grid">
  1482. <div class="md-copyright">
  1483. <div class="md-copyright__highlight">
  1484. &copy; 2024 The external-secrets Authors.<br/>
  1485. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1486. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1487. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1488. </div>
  1489. Made with
  1490. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1491. Material for MkDocs
  1492. </a>
  1493. </div>
  1494. </div>
  1495. </div>
  1496. </footer>
  1497. </div>
  1498. <div class="md-dialog" data-md-component="dialog">
  1499. <div class="md-dialog__inner md-typeset"></div>
  1500. </div>
  1501. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
  1502. <script src="../../assets/javascripts/bundle.1e8ae164.min.js"></script>
  1503. </body>
  1504. </html>