Returns the source definition of the supplied webhook, including its URL, headers, event filters, and state. Returns 400 webhook_not_found if the id does not exist or is not accessible.
GET
https://api.extole.io
/
v6
/
webhooks
/
{webhook_id}
Get a webhook
curl --request GET \ --url https://api.extole.io/v6/webhooks/{webhook_id} \ --header 'Authorization: <api-key>'
The client key id as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use WebhookBuildtimeContext.
The default method as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use WebhookBuildtimeContext.
The description as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use WebhookBuildtimeContext.
The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use WebhookBuildtimeContext.
The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use WebhookBuildtimeContext. Runtime expressions use WebhookRuntimeContext.
if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use WebhookBuildtimeContext. Runtime expressions use WebhookResponseContext.
The retry intervals as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use WebhookBuildtimeContext.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Extole Documentation","description":"Guides, product documentation, and API reference for the Extole platform.","colors":{"primary":"#ee0049","light":"#ee0049","dark":"#ee0049"},"logo":{"light":"https://mintcdn.com/extole/qEcOgc0BuXrP2LAU/extole-logo.png?fit=max\u0026auto=format\u0026n=qEcOgc0BuXrP2LAU\u0026q=85\u0026s=d7152863dcc1c598d4fac27f91b3658e","dark":"https://mintcdn.com/extole/qEcOgc0BuXrP2LAU/extole-logo.png?fit=max\u0026auto=format\u0026n=qEcOgc0BuXrP2LAU\u0026q=85\u0026s=d7152863dcc1c598d4fac27f91b3658e","href":"/"},"favicon":{"light":"https://mintcdn.com/extole/qEcOgc0BuXrP2LAU/Extole-icon-bug.svg?fit=max\u0026auto=format\u0026n=qEcOgc0BuXrP2LAU\u0026q=85\u0026s=963cb7a87707b61559c35c47c8d7fd14","dark":"https://mintcdn.com/extole/qEcOgc0BuXrP2LAU/Extole-icon-bug.svg?fit=max\u0026auto=format\u0026n=qEcOgc0BuXrP2LAU\u0026q=85\u0026s=963cb7a87707b61559c35c47c8d7fd14"},"api":{"url":"full"},"navbar":{"links":[{"href":"https://github.com/extole","label":"GitHub"},{"href":"https://my.extole.com","label":"My Extole"},{"href":"#request-sandbox","label":"Request Sandbox"}]},"footer":{"socials":{"github":"https://github.com/extole"}},"integrations":{"ga4":{"measurementId":"G-7QCR5R4J61"}},"contextual":{"options":["copy","assistant","download-spec","chatgpt","claude","cursor"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"extole","hasAudioNarration":false,"actualSubdomain":"extole","customDomains":["docs.extole.com"],"gitSource":{"type":"github","owner":"extole","repo":"product-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"agentFeedback":true,"thumbs":true,"issues":true,"edits":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af238b8df0682813ec0c847","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":447},{"language":"default","tag":"Management API","count":310},{"language":"default","tag":"Guides","count":253},{"language":"default","tag":"Technical Docs","count":130},{"language":"default","tag":"Server to Extole API","count":72},{"language":"default","tag":"Programs \u0026 Campaigns","count":58},{"language":"default","tag":"Dashboards and Reporting","count":57},{"language":"default","tag":"Product Docs","count":56},{"language":"default","tag":"Components","count":49},{"language":"default","tag":"Product Overview","count":40}],"searchSettings":{"maxResults":20,"showContentSnippets":true,"isFiltersEnabled":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"public/style.css","content":":root{--extole-coral: #ee0049;--extole-navy: #0b123d;--extole-primary-fill: #ee0049;--extole-icon-navy-bg: #0b123d;--extole-slate: #7d90a4;--extole-ink: #151a2d;--extole-muted: #4f5c6d;--extole-page-bg: #faf9f7;--extole-card-bg: #faf9f7;--extole-surface: #ffffff;--extole-surface-muted: rgba(255, 255, 255, 0.45);--extole-logo-bg: #ffffff;--extole-secondary-bg: #ffffff;--extole-border: #e2e2e0;--extole-border-strong: #d0dae6;--extole-shadow: 0 16px 44px rgba(11, 18, 61, 0.08);--extole-hero-shadow: 0 10px 32px rgba(11, 18, 61, 0.06);--extole-radius: 16px;--extole-heading-font: \"PaperMono\", \"Space Mono\", \"SFMono-Regular\", Menlo, Monaco, Consolas, monospace}html,body{background:var(--extole-page-bg)}html:not(.dark):not([data-theme=\"dark\"]):not([data-color-mode=\"dark\"]) #background-color{background-color:var(--extole-page-bg)!important}body{color:var(--extole-ink);font-family:\"Inter\", \"Poppins\", \"Montserrat\", \"Segoe UI\", sans-serif}.dark body,html.dark body,body.dark,:root[data-theme=\"dark\"] body,[data-theme=\"dark\"] body,[data-color-mode=\"dark\"] body{background:#0f1526}.nav-logo{height:24px!important;max-width:84px!important;object-fit:contain}.extole-home{color:var(--extole-ink);color-scheme:light;max-width:1440px;margin:0 auto;padding:16px 16px 96px;width:100%}.dark .extole-home,html.dark .extole-home,body.dark .extole-home,:root[data-theme=\"dark\"] .extole-home,[data-theme=\"dark\"] .extole-home,[data-color-mode=\"dark\"] .extole-home,body[data-theme=\"dark\"] .extole-home,html[data-theme=\"dark\"] .extole-home{--extole-coral: #ee0049;--extole-navy: #f3f6ff;--extole-primary-fill: #ee0049;--extole-icon-navy-bg: #263455;--extole-slate: #9cacbf;--extole-ink: #e5ebf7;--extole-muted: #b4bfd2;--extole-card-bg: #151c31;--extole-surface: #1d263d;--extole-surface-muted: rgba(255, 255, 255, 0.06);--extole-logo-bg: rgba(248, 250, 255, 0.96);--extole-secondary-bg: rgba(255, 255, 255, 0.03);--extole-border: rgba(178, 191, 216, 0.16);--extole-border-strong: rgba(205, 218, 242, 0.28);--extole-shadow: 0 20px 48px rgba(0, 0, 0, 0.36);--extole-hero-shadow: 0 16px 36px rgba(0, 0, 0, 0.28);color-scheme:dark}.extole-hero{display:grid;grid-template-columns:minmax(0, 1.12fr) minmax(420px, 0.88fr);gap:28px;align-items:stretch}.extole-hero-copy,.extole-code-panel{border:1px solid var(--extole-border);border-radius:24px;box-shadow:var(--extole-hero-shadow)}.extole-hero-copy{min-height:0;padding:46px 43px;background:var(--extole-card-bg)}.extole-kicker,.extole-code-kicker{margin:0 0 18px;color:var(--extole-coral);font-size:13px;font-weight:700;letter-spacing:0.12em;text-transform:uppercase}.extole-hero h1,.extole-section h2{color:var(--extole-navy);font-family:var(--extole-heading-font);font-weight:700;letter-spacing:-0.01em}.extole-hero h1{max-width:720px;margin:0 0 17px;font-size:clamp(1.9rem, 3vw, 2.7rem);line-height:1.15}.extole-lede{max-width:58ch;margin:0;color:var(--extole-muted);font-size:1.04rem;line-height:1.65}.extole-actions{display:flex;flex-wrap:wrap;gap:12px;margin-top:31px}.extole-btn{display:inline-flex;min-height:48px;min-width:178px;align-items:center;justify-content:center;border-radius:12px;padding:0 20px;font-family:var(--extole-heading-font);font-size:15px;font-weight:600;text-decoration:none!important;transition:transform 160ms ease, box-shadow 160ms ease, border-color 160ms ease}.extole-btn:hover{transform:translateY(-1px)}.extole-btn-primary{background:var(--extole-primary-fill);color:#ffffff!important;box-shadow:0 10px 22px rgba(11, 18, 61, 0.22)}.extole-btn-secondary{border:1px solid var(--extole-border-strong);background:var(--extole-secondary-bg);color:var(--extole-navy)!important}.extole-sandbox{margin-top:30px;color:var(--extole-muted);font-size:0.92rem}.extole-sandbox a{color:var(--extole-navy);font-weight:600}.extole-code-panel{max-height:500px;min-width:0;overflow:hidden;padding:30px 26px;background:radial-gradient(circle at 90% 0%, rgba(224, 0, 73, 0.36), transparent 38%),\n linear-gradient(160deg, #131a47 0%, #0b123d 56%, #070c28 100%);color:#ffffff}.extole-code-kicker{color:#93a4d2}.extole-code-panel [class*=\"codeblock\"],.extole-code-panel pre,.extole-code-panel code{font-family:\"PaperMono\", \"SFMono-Regular\", Consolas, monospace!important}.extole-code-panel pre{background:transparent!important;color:#d4d4d4;font-size:0.84rem;line-height:1.65;margin:0;max-height:365px;overflow-x:hidden;overflow-y:auto;scrollbar-color:rgba(160, 173, 205, 0.3) rgba(8, 14, 39, 0.28);scrollbar-width:thin;text-align:left;white-space:pre;word-break:normal}.extole-code-panel .line{display:block;min-height:1.65em}.extole-code-panel .tok-comment{color:#6a9955}.extole-code-panel .tok-keyword,.extole-code-panel .tok-tag{color:#569cd6}.extole-code-panel .tok-attr,.extole-code-panel .tok-property,.extole-code-panel .tok-variable{color:#9cdcfe}.extole-code-panel .tok-string{color:#ce9178}.extole-code-panel .tok-function{color:#dcdcaa}.extole-code-panel .tok-number{color:#b5cea8}.extole-code-panel .tok-type{color:#4ec9b0}.extole-code-panel pre::-webkit-scrollbar{width:8px}.extole-code-panel pre::-webkit-scrollbar-track{background:rgba(8, 14, 39, 0.28);border-radius:10px}.extole-code-panel pre::-webkit-scrollbar-thumb{background:rgba(160, 173, 205, 0.3);border-radius:10px}.extole-code-tabs{display:flex;gap:18px;margin-bottom:18px;border-bottom:1px solid rgba(138, 156, 201, 0.24)}.extole-code-tab{display:inline-flex;padding-bottom:10px;color:#9fb0dd;cursor:pointer;font-family:var(--extole-heading-font);font-size:0.78rem}.extole-tab-radio{block-size:1px;inline-size:1px;margin:0;opacity:0;overflow:hidden;pointer-events:none;position:absolute}.extole-code-block{display:none}#extole-code-tab-js:checked~.extole-code-tabs .extole-code-tab[for=\"extole-code-tab-js\"],#extole-code-tab-react-native:checked~.extole-code-tabs .extole-code-tab[for=\"extole-code-tab-react-native\"],#extole-code-tab-ios:checked~.extole-code-tabs .extole-code-tab[for=\"extole-code-tab-ios\"],#extole-code-tab-android:checked~.extole-code-tabs .extole-code-tab[for=\"extole-code-tab-android\"]{border-bottom:2px solid #f5e7a5;color:#f4f8ff}#extole-code-tab-js:checked~.extole-code-block-js,#extole-code-tab-react-native:checked~.extole-code-block-react-native,#extole-code-tab-ios:checked~.extole-code-block-ios,#extole-code-tab-android:checked~.extole-code-block-android{display:block}.extole-link-strip{display:grid;grid-template-columns:repeat(4, minmax(0, 1fr));margin-top:42px;overflow:hidden;border:1px solid var(--extole-border);border-radius:24px;background:var(--extole-card-bg)}.extole-link-strip a{display:flex;min-height:78px;align-items:center;gap:14px;padding:18px 24px;color:var(--extole-ink);text-decoration:none!important}.extole-link-strip a+a{border-left:1px solid var(--extole-border)}.extole-link-strip strong{font-family:\"PaperMono\", \"SFMono-Regular\", Consolas, monospace;font-family:var(--extole-heading-font);font-size:15px;letter-spacing:0}.extole-icon{display:inline-flex;width:38px;height:38px;flex:0 0 38px;align-items:center;justify-content:center;border-radius:11px;color:#fff;font-size:13px;font-weight:800}.extole-icon svg,.extole-support-icon svg{display:block;height:22px;width:22px;fill:none;stroke:currentColor;stroke-linecap:round;stroke-linejoin:round;stroke-width:1.8}.extole-icon span{line-height:1}.extole-icon-navy{background:var(--extole-icon-navy-bg)}.extole-icon-gray{background:#7c8191}.extole-icon-pink{background:var(--extole-coral)}.extole-icon-blue{background:#a7d8eb}.extole-icon-yellow{background:#fee64b;color:var(--extole-ink)}.extole-icon-react{background:#0b1748;color:#61dafb}.extole-icon-black{background:#171717}.extole-icon-green{background:#9fcb4a}.extole-section{margin-top:50px;padding:50px 0}.extole-section h2{margin:0;font-size:clamp(1.35rem, 2vw, 1.9rem);line-height:1.2}.extole-section>p:not(.extole-kicker){max-width:720px;margin:16px 0 28px;color:var(--extole-muted);font-size:17px}.extole-pattern-grid{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:18px}.extole-stack-layout{display:grid;gap:14px}.extole-stack-pattern{background:var(--extole-card-bg);border:1px solid var(--extole-border);border-radius:var(--extole-radius);display:grid;gap:20px;grid-template-columns:minmax(0, 30%) minmax(0, 70%);padding:24px}.extole-stack-pattern-head h3{color:var(--extole-navy);font-family:var(--extole-heading-font);margin:0 0 10px}.extole-stack-pattern-head p{color:var(--extole-muted);font-size:0.9rem;line-height:1.55;margin:0}.extole-stack-pattern-groups{display:grid;gap:12px;grid-template-columns:repeat(2, minmax(0, 1fr))}.extole-stack-group{background:var(--extole-surface);border:1px solid var(--extole-border);border-radius:12px;padding:12px 14px}.extole-stack-group-title{color:var(--extole-muted);font-family:var(--extole-heading-font);font-size:0.68rem;font-weight:600;letter-spacing:0.08em;line-height:1.2;margin:0 0 9px;text-transform:uppercase}.extole-stack-group ul{list-style:none!important;margin:0;padding:0!important}.extole-stack-group li+li{border-top:1px solid var(--extole-border);margin-top:7px;padding-top:7px}.extole-stack-group a,.extole-devhub a:not(.extole-btn):not(.extole-partner-item):not(.extole-pattern-card){color:var(--extole-navy);font-weight:600;text-decoration:underline;text-decoration-color:rgba(11, 18, 61, 0.35);text-decoration-thickness:1px;text-underline-offset:2px}.extole-stack-group a:hover,.extole-devhub a:not(.extole-btn):not(.extole-partner-item):not(.extole-pattern-card):hover{color:var(--extole-coral);text-decoration-color:rgba(238, 0, 73, 0.65)}.extole-partner-filter-layout{align-items:start;display:grid;gap:20px;grid-template-columns:minmax(220px, 260px) minmax(0, 1fr)}.extole-partner-filter-panel{display:grid;gap:10px}.extole-partner-filter-title{color:var(--extole-navy);font-family:var(--extole-heading-font);font-size:0.9rem;margin:0}.extole-partner-filter-copy{color:var(--extole-muted);font-size:0.86rem;line-height:1.45;margin:-2px 0 4px}.extole-partner-filter-option{align-items:self-end;color:var(--extole-muted);column-gap:10px;cursor:pointer;display:grid;grid-template-columns:16px minmax(0, 1fr);line-height:1.35}.extole-partner-filter-option span{font-family:var(--extole-heading-font);font-size:0.74rem;line-height:1.25}.extole-partner-filter-input{accent-color:var(--extole-coral);height:16px;margin:2px 0 0;width:16px}.extole-partner-filter-option:has(.extole-partner-filter-input:checked){color:var(--extole-navy);font-weight:600}.extole-partner-surface{background:var(--extole-card-bg);border:1px solid var(--extole-border);border-radius:var(--extole-radius);padding:4px}.extole-partner-grid{display:grid;gap:8px;grid-template-columns:repeat(4, minmax(0, 1fr))}.extole-partner-item{border-radius:12px;color:var(--extole-navy);display:block;min-height:178px;padding:14px 16px;text-decoration:none!important;transition:background-color 0.2s ease, box-shadow 0.2s ease}.extole-partner-item:hover{background:var(--extole-surface-muted);box-shadow:0 8px 18px rgba(11, 18, 61, 0.08)}.extole-partner-logo{align-items:center;background:var(--extole-logo-bg);border:1px solid var(--extole-border);border-radius:10px;display:inline-flex;height:44px;justify-content:center;margin:0 0 12px;padding:8px 12px}.extole-partner-logo img{display:block;height:100%;max-width:120px;object-fit:contain;width:auto}.extole-partner-item h3{color:var(--extole-navy);font-family:var(--extole-heading-font);font-size:0.94rem;line-height:1.35;margin:0 0 8px}.extole-partner-item p{color:var(--extole-muted);font-size:0.82rem;line-height:1.45;margin:0}.extole-partner-filter-layout:has(#partner-filter-cep:checked) .extole-partner-item:not(.partner-cat-cep),.extole-partner-filter-layout:has(#partner-filter-ecommerce:checked) .extole-partner-item:not(.partner-cat-ecommerce),.extole-partner-filter-layout:has(#partner-filter-banking:checked) .extole-partner-item:not(.partner-cat-banking),.extole-partner-filter-layout:has(#partner-filter-cdp:checked) .extole-partner-item:not(.partner-cat-cdp),.extole-partner-filter-layout:has(#partner-filter-crm:checked) .extole-partner-item:not(.partner-cat-crm),.extole-partner-filter-layout:has(#partner-filter-rewards:checked) .extole-partner-item:not(.partner-cat-rewards),.extole-partner-filter-layout:has(#partner-filter-analytics:checked) .extole-partner-item:not(.partner-cat-analytics),.extole-partner-filter-layout:has(#partner-filter-tag:checked) .extole-partner-item:not(.partner-cat-tag),.extole-partner-filter-layout:has(#partner-filter-automation:checked) .extole-partner-item:not(.partner-cat-automation){display:none}.extole-support-grid{background:var(--extole-card-bg);border:1px solid var(--extole-border);border-radius:var(--extole-radius);display:grid;gap:18px;grid-template-columns:repeat(3, minmax(0, 1fr));margin-top:28px;padding:24px}.extole-pattern-card{display:block;min-height:100%;padding:24px;border:1px solid var(--extole-border);border-radius:var(--extole-radius);background:var(--extole-card-bg);box-shadow:0 8px 24px rgba(11, 18, 61, 0.05);color:var(--extole-ink);text-decoration:none!important}.extole-support-icon{align-items:center;border-radius:14px;color:#ffffff;display:inline-flex;height:44px;justify-content:center;margin-bottom:18px;width:44px}.extole-support-icon-help{background:var(--extole-coral)}.extole-support-icon-ticket{background:#3c4260}.extole-support-icon-status{background:#47b881}.extole-pattern-card h3{margin:0 0 12px;color:var(--extole-navy);font-family:var(--extole-heading-font);font-size:1.02rem}.extole-pattern-card p{margin:0;color:var(--extole-muted);font-size:0.93rem;line-height:1.6}.extole-card-cta{display:inline-flex;margin-top:16px;color:var(--extole-navy);font-family:var(--extole-heading-font);font-size:0.88rem;font-weight:600;text-decoration:underline;text-decoration-color:rgba(11, 18, 61, 0.35);text-decoration-thickness:1px;text-underline-offset:2px}@media (max-width: 1100px){.extole-hero{grid-template-columns:1fr}.extole-hero-copy{min-height:auto}}@media (max-width: 1024px){.extole-partner-grid{grid-template-columns:repeat(3, minmax(0, 1fr))}.extole-partner-filter-layout{grid-template-columns:minmax(190px, 230px) minmax(0, 1fr)}.extole-stack-pattern{gap:14px;grid-template-columns:1fr}}@media (max-width: 900px){.extole-stack-pattern-groups{grid-template-columns:1fr}.extole-partner-filter-layout{gap:14px;grid-template-columns:1fr}.extole-partner-filter-panel{grid-template-columns:repeat(2, minmax(0, 1fr))}.extole-partner-filter-title,.extole-partner-filter-copy{grid-column:1 / -1}}@media (max-width: 820px){.extole-home{padding:12px 14px 64px}.extole-hero-copy,.extole-code-panel{border-radius:18px;padding:28px 22px}.extole-link-strip,.extole-pattern-grid,.extole-support-grid{grid-template-columns:1fr}.extole-link-strip a+a{border-left:0;border-top:1px solid var(--extole-border)}}@media (max-width: 640px){.extole-section{margin-top:20px;padding:20px 0}.extole-partner-surface{padding:0}.extole-partner-grid{grid-template-columns:1fr}.extole-partner-filter-panel{display:none}.extole-partner-filter-layout{grid-template-columns:1fr}.extole-stack-pattern{padding:20px}.extole-stack-group{padding:11px 12px}.extole-btn{min-width:100%;width:100%}.extole-actions{flex-direction:column}}"},{"filePath":"style.css","content":".object-param-field [data-component-part=\"tabs-list\"]{display:none!important}[role=\"dialog\"] [data-component-part=\"tabs-list\"]:has([data-component-part=\"tab\"]:nth-child(2)),[role=\"dialog\"] [data-component-part=\"tabs-list\"]:has([role=\"tab\"]:nth-child(2)){position:absolute!important;left:0!important;top:0!important;width:1px!important;min-width:0!important;max-width:1px!important;height:1px!important;min-height:0!important;max-height:1px!important;padding:0!important;margin:0!important;overflow:hidden!important;clip:rect(0, 0, 0, 0)!important;clip-path:inset(50%)!important;white-space:nowrap!important;border:0!important;opacity:0!important;pointer-events:none!important}[role=\"dialog\"] [data-testid=\"api-input-type\"].extole-type-field-hidden{position:absolute!important;width:1px!important;height:1px!important;padding:0!important;margin:-1px!important;overflow:hidden!important;clip:rect(0, 0, 0, 0)!important;clip-path:inset(50%)!important;white-space:nowrap!important;border:0!important;opacity:0!important;pointer-events:none!important}.extole-type-combo{display:flex;flex-wrap:wrap;gap:0.5rem;align-items:center;margin:0 0 0.75rem}.extole-type-combo label{font-size:0.75rem;font-weight:600;color:#78716c}html.dark .extole-type-combo label,html.dark .extole-type-combo-meta,html.dark .extole-type-combo-empty{color:#a8a29e}.extole-type-combo-wrap{position:relative;flex:1 1 16rem;min-width:16rem;cursor:pointer}.extole-type-combo-wrap input{box-sizing:border-box;width:100%;min-width:16rem;margin:0;padding:0.5rem 2rem 0.5rem 0.75rem;border:1px solid #d6d3d1;border-radius:0.5rem;background:#fff;color:inherit;font:inherit;font-family:ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace;font-size:0.8125rem;line-height:1.25rem;cursor:pointer}.extole-type-combo-wrap input:focus{cursor:text;outline:2px solid rgb(238 0 73 / 0.35);outline-offset:1px}html.dark .extole-type-combo-wrap input{border-color:#44403c;background:#1c1917}.extole-type-combo-wrap::after{content:\"\";position:absolute;top:50%;right:0.85rem;width:0;height:0;border-left:4px solid transparent;border-right:4px solid transparent;border-top:5px solid #78716c;transform:translateY(-50%);pointer-events:none}.extole-type-combo-menu{position:absolute;z-index:40;top:calc(100% + 0.25rem);left:0;right:0;max-height:18rem;overflow:auto;border:1px solid #d6d3d1;border-radius:0.5rem;background:#fff;box-shadow:0 10px 30px rgb(0 0 0 / 0.12)}html.dark .extole-type-combo-menu{border-color:#44403c;background:#1c1917}.extole-type-combo-menu button{display:block;width:100%;margin:0;padding:0.5rem 0.75rem;border:0;background:transparent;color:inherit;font:inherit;font-family:ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace;font-size:0.75rem;text-align:left;cursor:pointer}.extole-type-combo-menu button:hover,.extole-type-combo-menu button[aria-selected=\"true\"]{background:rgb(28 25 23 / 0.06);color:var(--api-ink)}html.dark .extole-type-combo-menu button:hover,html.dark .extole-type-combo-menu button[aria-selected=\"true\"]{background:rgb(255 255 255 / 0.08);color:var(--api-ink)}.extole-type-combo-empty{padding:0.75rem;font-size:0.75rem;color:#78716c}.extole-type-combo-meta{font-size:0.75rem;color:#78716c;font-variant-numeric:tabular-nums;white-space:nowrap;min-width:12ch}.extole-eval-combo{display:flex;flex-wrap:wrap;gap:0.5rem;align-items:center;margin:0 0 0.75rem}.extole-eval-combo-wrap{position:relative;flex:1 1 16rem;min-width:16rem}.extole-eval-combo-select{box-sizing:border-box;width:100%;min-width:16rem;margin:0;padding:0.5rem 2rem 0.5rem 0.75rem;border:1px solid #d6d3d1;border-radius:0.5rem;background:#fff;color:inherit;font:inherit;font-family:ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace;font-size:0.8125rem;line-height:1.25rem;appearance:none;cursor:pointer}.extole-eval-combo-select:focus{outline:2px solid rgb(238 0 73 / 0.35);outline-offset:1px}html.dark .extole-eval-combo-select{border-color:#44403c;background:#1c1917}.extole-eval-combo-wrap::after{content:\"\";position:absolute;top:50%;right:0.85rem;width:0;height:0;border-left:4px solid transparent;border-right:4px solid transparent;border-top:5px solid #78716c;transform:translateY(-50%);pointer-events:none}.extole-eval-map{margin:0.35rem 0 0.5rem}.extole-eval-map-list{display:flex;flex-direction:column;gap:0.5rem}.extole-eval-map-row{display:flex;flex-wrap:wrap;gap:0.4rem;align-items:center}.extole-eval-map-key,.extole-eval-map-type,.extole-eval-map-input{box-sizing:border-box;margin:0;padding:0.45rem 0.7rem;border:1px solid #d6d3d1;border-radius:0.5rem;background:#fff;color:inherit;font:inherit;font-family:ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace;font-size:0.8125rem;line-height:1.25rem}.extole-eval-map-key{width:7.5rem}.extole-eval-map-type{width:13.5rem;padding-right:1.6rem;appearance:auto;cursor:pointer}.extole-eval-map-val{display:flex;flex:1 1 12rem;min-width:10rem;align-items:center;border:1px solid #d6d3d1;border-radius:0.5rem;background:#fff}.extole-eval-map-val.is-invalid{border-color:#ee0049}.extole-eval-map-prefix{flex:0 0 auto;padding:0 0 0 0.65rem;color:#78716c;font-family:ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace;font-size:0.7rem;white-space:nowrap}.extole-eval-map-val .extole-eval-map-input{flex:1 1 auto;min-width:0;border:0;background:transparent}html.dark .extole-eval-map-key,html.dark .extole-eval-map-type,html.dark .extole-eval-map-val,html.dark .extole-eval-map-input{border-color:#44403c;background:#1c1917}html.dark .extole-eval-map-val .extole-eval-map-input{background:transparent}html.dark .extole-eval-map-remove{border-color:#44403c;color:#a8a29e}.extole-eval-map-key:focus,.extole-eval-map-type:focus,.extole-eval-map-val:focus-within{outline:2px solid rgb(238 0 73 / 0.35);outline-offset:1px}.extole-eval-map-hint{flex:1 0 100%;margin:0;font-size:0.75rem;color:#ee0049}.extole-eval-map-remove{width:2rem;height:2rem;padding:0;border:1px solid #d6d3d1;border-radius:0.5rem;background:transparent;color:#78716c;cursor:pointer;font-size:1rem;line-height:1}.extole-eval-map-add{margin:0.15rem 0 0;padding:0;border:0;background:transparent;color:#ee0049;font-size:0.8125rem;cursor:pointer}[data-testid=\"api-input-values\"].extole-eval-map-on>.grid{display:none!important}html[data-extole-driving] [role=\"menu\"]{display:none!important}select.extole-eval-native-hidden{position:absolute!important;width:1px!important;height:1px!important;padding:0!important;margin:-1px!important;overflow:hidden!important;clip:rect(0, 0, 0, 0)!important;clip-path:inset(50%)!important;white-space:nowrap!important;border:0!important;opacity:0!important;pointer-events:none!important}:root{--api-ink: #1c1917;--api-body: #44403c;--api-meta: #57534e;--api-faint: #a8a29e;--api-accent: #b3003a;--api-warn: #b45309;--api-rule: #ded9d1;--api-rule-soft: #ebe7e1;--api-panel: transparent;--api-row: transparent;--api-wash: rgb(179 0 58 / 0.07);--api-row-pad: 0.625rem;--api-gap: 0.375rem}html.dark{--api-ink: #f5f3f1;--api-body: #d6d3d1;--api-meta: #a8a29e;--api-faint: #78716c;--api-accent: #ff7096;--api-warn: #fcd34d;--api-rule: #46403d;--api-rule-soft: #2f2a28;--api-panel: rgb(255 255 255 / 0.04);--api-row: rgb(255 255 255 / 0.022);--api-wash: rgb(255 112 150 / 0.10)}.primitive-param-field>.py-6,.object-param-field>.py-6,.array-param-field>.py-6{padding-block:var(--api-row-pad)}@supports selector(:has(*)){div:has(>.param-head){padding-block:var(--api-row-pad)}}.param-head>div{padding-block:0;margin-right:0}.param-head>div>div{row-gap:0.125rem;column-gap:0.5rem}.param-head [data-component-part=\"field-meta\"]>div{line-height:20px}.param-head~div:not(:empty){margin-top:var(--api-gap)}.param-head~div:not(:empty)>*{margin-top:0}.param-head~div:not(:empty)>*+*{margin-top:var(--api-gap)}.primitive-param-field,.object-param-field,.array-param-field{border-color:var(--api-rule-soft)}.api-section-heading>div{border-bottom:0}@supports selector(:has(*)){div:has(>.method-pill){border:0}}@supports selector(:has(*)){.object-param-field:not(:has(>.py-6)):has(.param-head){margin-block:var(--api-gap);border:1px solid var(--api-rule);border-radius:0.5rem;padding:0.5rem;background:var(--api-panel)}}@supports selector(:has(*)){.primitive-param-field:has(>.py-6),.array-param-field:has(>.py-6),.object-param-field:has(>.py-6){margin-block:var(--api-gap);border:1px solid var(--api-rule);border-radius:0.375rem;padding-inline:0.75rem;background:var(--api-row)}}.param-head [data-component-part=\"field-name\"]{color:var(--api-ink);font-weight:600;letter-spacing:-0.006em}.param-head{word-break:normal;overflow-wrap:anywhere}.param-head [data-component-part=\"field-required-pill\"]{padding:0;border:0;border-radius:0;background:none;color:var(--api-meta);font-weight:500}.param-head [data-component-part=\"field-info-pill\"]+[data-component-part=\"field-required-pill\"]::before{content:\"\\00B7\";margin-right:0.35em;color:var(--api-faint)}.param-head[id^=\"response-\"] [data-component-part=\"field-required-pill\"]{display:none}.param-head [data-component-part=\"field-info-pill\"]{padding:0;border-radius:0;background:none;color:var(--api-meta);font-weight:500}.param-head [data-component-part=\"field-info-pill\"]+[data-component-part=\"field-info-pill\"]::before{content:\"\\00B7\";margin-right:0.35em;color:var(--api-faint)}.param-head [data-component-part=\"field-meta\"]>:last-child{margin-right:0}.param-head [data-component-part=\"field-meta-pre\"],.param-head [data-component-part=\"field-meta-post\"]{font-weight:400}.param-head [data-component-part=\"field-deprecated-pill\"]{padding:0;border-radius:0;background:none;color:var(--api-warn);font-size:0.6875rem;font-weight:500}.param-head~div .prose{color:var(--api-body)}.param-head~div .prose p{margin:0;font-size:0.875rem;line-height:1.55}.param-head~div .prose>*+*{margin-top:0.5rem}.param-head~div .prose code{color:var(--api-ink)}.param-head~div .prose-sm:not(.prose){color:var(--api-meta);font-size:0.75rem;line-height:1.45}.param-head~div .prose-sm:not(.prose) code{color:var(--api-body)}@supports selector(:has(*)){.primitive-param-field:not(:has(.param-head)) .prose-sm:not(.prose),.object-param-field:not(:has(.param-head)) .prose-sm:not(.prose),.array-param-field:not(:has(.param-head)) .prose-sm:not(.prose){margin-top:var(--api-gap)}}.param-head~div [data-component-part=\"expandable\"]{margin-top:0.5rem;border:0;border-radius:0}.param-head~div [data-component-part=\"expandable-button\"]{width:auto;padding:0.125rem 0;border-radius:0;color:var(--api-meta);font-size:0.75rem;font-weight:500}.param-head~div [data-component-part=\"expandable-button\"]:hover{background:none;color:var(--api-ink)}.param-head~div [data-component-part=\"expandable-content\"]{margin:0.25rem 0 0;padding:0 0 0 0.875rem;border-top:0;border-left:1px solid var(--api-rule)}.api-section-heading{gap:0.5rem}.api-section-heading-title{color:var(--api-meta);font-size:0.6875rem;font-weight:600;letter-spacing:0.08em;text-transform:uppercase}@supports selector(:has(*)){div:has(>.api-section){margin-bottom:2rem}}@supports selector(:has(*)){div:has(>.param-head:target){border-radius:2px;background:var(--api-wash);box-shadow:10px 0 0 var(--api-wash), -10px 0 0 var(--api-wash)}}.newsletter-container .lead{max-width:60ch;color:var(--api-body)}.nl-grid{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:1.5rem;margin-top:1.5rem}.nl-head h2{margin:0 0 0.75rem;padding-bottom:0.5rem;border-bottom:1px solid var(--api-rule);font-size:1.125rem}.nl-list{margin:0;padding:0;list-style:none!important}.nl-list>li::before{content:none!important;display:none!important}.nl-item{margin-bottom:0.75rem;padding:0.875rem;border:1px solid var(--api-rule);border-radius:0.5rem;background:var(--api-panel)}.nl-item__head{display:flex;gap:0.75rem;align-items:flex-start;justify-content:space-between}.nl-month{margin:0;color:var(--api-ink);font-size:0.9375rem;font-weight:600;line-height:1.4}.nl-item .actions{flex:0 0 auto}.nl-item .btn{display:inline-flex;align-items:center;padding:0.25rem 0.75rem;border:1px solid var(--api-rule);border-radius:0.375rem;color:var(--api-ink)!important;font-size:0.75rem;font-weight:600;text-decoration:none!important;white-space:nowrap}.nl-item .btn:hover{border-color:var(--api-meta)}.nl-item [data-component-part=\"accordion\"]{margin-top:0.625rem}.nl-item [data-component-part=\"accordion-content\"] ul{margin:0;color:var(--api-body);font-size:0.8125rem;line-height:1.55}@media (max-width: 820px){.nl-grid{grid-template-columns:1fr}}a[href=\"#request-sandbox\"]{align-items:center;background:#000!important;border-radius:999px;color:#fff!important;display:inline-flex;font-family:\"Poppins\", \"Inter\", sans-serif;font-size:0.8125rem;font-weight:600;justify-content:center;line-height:1;min-height:2.25rem;padding:0.625rem 0.875rem;text-decoration:none!important;transition:background-color 160ms ease, transform 160ms ease}a[href=\"#request-sandbox\"]:hover{background:#27272a!important;transform:translateY(-1px)}a[href=\"#request-sandbox\"]:focus-visible,.extole-sandbox-modal button:focus-visible{outline:3px solid #ee0049;outline-offset:3px}.extole-sandbox-open{overflow:hidden}.extole-sandbox-modal{align-items:center;background:rgb(11 18 61 / 0.64);display:flex;inset:0;justify-content:center;padding:1.5rem;position:fixed;z-index:10000}.extole-sandbox-modal[hidden]{display:none}.extole-sandbox-dialog{background:#fff;border-radius:1.25rem;box-shadow:0 24px 64px rgb(11 18 61 / 0.3);color:#151a2d;max-height:calc(100vh - 3rem);max-width:36rem;overflow:auto;padding:2rem;position:relative;width:100%}.extole-sandbox-dialog h2{color:#151a2d;font-family:\"Poppins\", \"Inter\", sans-serif;font-size:1.75rem;line-height:1.15;margin:0 2.5rem 0.5rem 0}.extole-sandbox-dialog p{color:#4f5c6d;font-family:\"Poppins\", \"Inter\", sans-serif;line-height:1.5;margin:0}.extole-sandbox-close{align-items:center;background:transparent;border:0;border-radius:999px;color:#151a2d;cursor:pointer;display:inline-flex;font-size:1.5rem;height:2.25rem;justify-content:center;padding:0;position:absolute;right:1.25rem;top:1.25rem;width:2.25rem}.extole-sandbox-close:hover{background:#f1f1f1}.extole-sandbox-form{display:grid;gap:1rem;grid-template-columns:repeat(2, minmax(0, 1fr));margin-top:1.5rem}.extole-sandbox-field{display:grid;gap:0.5rem}.extole-sandbox-field-full{grid-column:1 / -1}.extole-sandbox-privacy{color:#383848;font-family:\"Poppins\", \"Inter\", sans-serif;font-size:0.8em;grid-column:1 / -1;line-height:1.5;margin:0}.extole-sandbox-privacy a{color:#151a2d;font-size:inherit;font-weight:600;text-decoration:underline;text-underline-offset:0.125em}.extole-sandbox-captcha{grid-column:1 / -1}.extole-sandbox-error{color:#9f1239;font-size:0.875rem;grid-column:1 / -1;margin:0}.extole-sandbox-field label{color:#383848;font-family:\"Poppins\", \"Inter\", sans-serif;font-size:0.875rem;font-weight:600}.extole-sandbox-field input,.extole-sandbox-field textarea{background:#fff;border:1px solid #c7c7c7;border-radius:0.25rem;box-sizing:border-box;color:#000;font-family:\"Poppins\", \"Inter\", sans-serif;font-size:1rem;min-height:2.75rem;padding:0.5rem 0.75rem;width:100%}.extole-sandbox-field input:focus-visible,.extole-sandbox-field textarea:focus-visible{border-color:#ee0049;outline:0}.extole-sandbox-field textarea{min-height:7.5rem;resize:vertical}.extole-sandbox-field input::placeholder,.extole-sandbox-field textarea::placeholder{color:#777}.extole-sandbox-submit{background:#383848;border:0;border-radius:999px;color:#fff;cursor:pointer;font-family:\"Poppins\", \"Inter\", sans-serif;font-size:0.875rem;font-weight:600;grid-column:1 / -1;justify-self:start;margin-top:0.5rem;padding:0.75rem 1.25rem}.extole-sandbox-submit:hover{background:#000}.extole-sandbox-submit:disabled{cursor:wait;opacity:0.7}.extole-sandbox-success{display:grid;gap:1.25rem;margin-top:1.5rem}.extole-sandbox-success-icon{align-items:center;background:#e8f5ed;border-radius:999px;color:#187344;display:inline-flex;font-size:1.25rem;font-weight:700;height:2.75rem;justify-content:center;width:2.75rem}.extole-sandbox-success-copy{display:grid;gap:0.5rem}.extole-sandbox-success h3{color:#151a2d;font-family:\"Poppins\", \"Inter\", sans-serif;font-size:1rem;margin:0}.extole-sandbox-success[hidden],.extole-sandbox-form[hidden]{display:none}@media (max-width: 40rem){.extole-sandbox-dialog{border-radius:1rem;padding:1.5rem}.extole-sandbox-form{grid-template-columns:1fr}.extole-sandbox-submit{width:100%}}"}],"page":{"pagePath":"api-reference/webhooks/get-a-webhook","slug":"/api-reference/webhooks/get-a-webhook","pageMetadata":{"title":"Get a webhook","description":"Returns the source definition of the supplied webhook, including its URL, headers, event filters, and state. Returns `400 webhook_not_found` if the id does not exist or is not accessible.","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/webhooks/{webhook_id}","href":"/api-reference/webhooks/get-a-webhook","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns the source definition of the supplied webhook, including its URL, headers, event filters, and state. Returns \", _jsx(_components.code, {\n children: \"400 webhook_not_found\"\n }), \" if the id does not exist or is not accessible.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get a webhook","description":"Returns the source definition of the supplied webhook, including its URL, headers, event filters, and state. Returns `400 webhook_not_found` if the id does not exist or is not accessible.","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/webhooks/{webhook_id}","href":"/api-reference/webhooks/get-a-webhook","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/extole/f41fea9c3aac4d55/type-combobox.js","/_mintlify/custom/extole/83546dbecca8dd1c/evaluatable-map.js","/_mintlify/custom/extole/8a8483f8fc226986/evaluatable-selector.js","/_mintlify/custom/extole/83812e823faa6683/request-sandbox.js"],"openApiReferenceData":{"operation":{"description":"Returns the source definition of the supplied webhook, including its URL, headers, event filters, and state. Returns `400 webhook_not_found` if the id does not exist or is not accessible.","parameters":["37d5e6fe-87bf-4807-b4b8-65dc8f2104c7"],"responses":{"200":"21104c29-f562-43e4-8ec9-b0544d80f0cb","400":"f9bbf47e-5c19-45cc-b5a8-395d04574f11","401":"5862247a-4fa5-4e2d-b592-3d782aa4c999","402":"412564cc-f647-4929-83ac-062d8a50b1fc","403":"38cee6f7-8931-4b8d-b1c2-e3489d27f439","415":"3ee040ed-137e-4c57-b599-d1be53b8bc61","429":"d4171a97-867e-447b-a83a-a0538e711233"},"summary":"Get a webhook","tags":["Webhooks"],"x-extole-bundle":"management","x-extole-visibility":"visible","method":"get","type":"path","servers":["2e4faa6f-8cce-47ce-a111-236281ef5887"],"security":["91f5e9e9-c7e0-44a0-8a13-0d0c8ba2f0e8","caafc15f-442e-4dec-8558-8aadb3968b74","a66f474d-bd77-4222-b723-0f93edbc195b"],"path":"/v6/webhooks/{webhook_id}","baseUrlOptions":["https://api.extole.io"],"title":"Get a webhook","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","urlDisplay":"full"},"dependencies":{"parameters":{"37d5e6fe-87bf-4807-b4b8-65dc8f2104c7":{"in":"path","name":"webhook_id","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"21104c29-f562-43e4-8ec9-b0544d80f0cb":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"CLIENT","description":"Stored client webhook definition. Fields `name`, `url`, `client_key_id`, `request`, `response_handler`, `enabled`, `description`, `default_method`, and `retry_intervals` are unevaluated and appear in buildtime-evaluatable form.","required":["client_key_id","component_ids","component_references","created_at","default_method","description","enabled","id","name","request","response_handler","retry_intervals","tags","type","updated_at","url"],"properties":{"client_key_id":{"oneOf":[{"type":"string","title":"Static Value","description":"The client key id as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.0.client_key_id.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"The client key id as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{clientKeyId}}","isRequired":true,"uniqueKey":"oneOf.0.client_key_id.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The client key id as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('clientKeyId');}","isRequired":true,"uniqueKey":"oneOf.0.client_key_id.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.0.client_key_id","typeLabel":"string"},"component_ids":{"items":{"type":"string","uniqueKey":"oneOf.0.component_ids.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"oneOf.0.component_ids","typeLabel":"string[]"},"component_references":{"items":{"properties":{"component_id":{"type":"string","uniqueKey":"oneOf.0.component_references.items.[INDEX].component_id","typeLabel":"string"},"socket_names":{"items":{"type":"string","uniqueKey":"oneOf.0.component_references.items.[INDEX].socket_names.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"oneOf.0.component_references.items.[INDEX].socket_names","typeLabel":"string[]"}},"type":"object","uniqueKey":"oneOf.0.component_references.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"oneOf.0.component_references","typeLabel":"object[]"},"created_at":{"description":"[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.","example":"2025-10-24T02:00:00-07:00","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\\[[^\\]]+\\])?$","type":"string","isRequired":true,"uniqueKey":"oneOf.0.created_at","typeLabel":"string"},"default_method":{"oneOf":[{"type":"string","title":"Static Value","description":"The default method as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.0.default_method.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"The default method as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{defaultMethod}}","isRequired":true,"uniqueKey":"oneOf.0.default_method.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The default method as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('defaultMethod');}","isRequired":true,"uniqueKey":"oneOf.0.default_method.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.0.default_method","typeLabel":"string"},"description":{"oneOf":[{"type":"string","title":"Static Value","description":"The description as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"The description as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{description}}","isRequired":true,"uniqueKey":"oneOf.0.description.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The description as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('description');}","isRequired":true,"uniqueKey":"oneOf.0.description.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.0.description","typeLabel":"string"},"enabled":{"oneOf":[{"type":"boolean","title":"Static Value","description":"The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.0.enabled.oneOf.0","typeLabel":"boolean"},{"type":"string","title":"Buildtime - Handlebars","description":"The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{enabled}}","isRequired":true,"uniqueKey":"oneOf.0.enabled.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('enabled');}","isRequired":true,"uniqueKey":"oneOf.0.enabled.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.0.enabled","typeLabel":"boolean · string · string"},"id":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"oneOf.0.id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","title":"Static Value","description":"The name as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"The name as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{name}}","isRequired":true,"uniqueKey":"oneOf.0.name.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The name as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('name');}","isRequired":true,"uniqueKey":"oneOf.0.name.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.0.name","typeLabel":"string"},"request":{"oneOf":[{"type":"object","title":"Static Value","description":"The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).","required":["headers","method","url","urlTemplateParameters"],"properties":{"headers":{"additionalProperties":{"items":{"type":"string","uniqueKey":"oneOf.0.request.oneOf.0.headers.additionalProperties.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"oneOf.0.request.oneOf.0.headers.additionalProperties","typeLabel":"string[]"},"type":"object","isRequired":true,"uniqueKey":"oneOf.0.request.oneOf.0.headers","typeLabel":"object"},"method":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.request.oneOf.0.method","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.request.oneOf.0.url","typeLabel":"string"},"urlTemplateParameters":{"additionalProperties":{"type":"string","uniqueKey":"oneOf.0.request.oneOf.0.urlTemplateParameters.additionalProperties","typeLabel":"string"},"type":"object","isRequired":true,"uniqueKey":"oneOf.0.request.oneOf.0.urlTemplateParameters","typeLabel":"object"},"body":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.request.oneOf.0.body.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.0.request.oneOf.0.body.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.request.oneOf.0.body","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"oneOf.0.request.oneOf.0","typeLabel":"Static Value · object"},{"type":"string","title":"Buildtime - Handlebars","description":"The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{request}}","isRequired":true,"uniqueKey":"oneOf.0.request.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('request');}","isRequired":true,"uniqueKey":"oneOf.0.request.oneOf.2","typeLabel":"string"},{"type":"string","title":"Runtime - Handlebars","description":"The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).","pattern":"^handlebars@runtime:.*","example":"handlebars@runtime:{{request}}","isRequired":true,"uniqueKey":"oneOf.0.request.oneOf.3","typeLabel":"string"},{"type":"string","title":"Runtime - Javascript","description":"The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).","pattern":"^javascript@runtime:.*","example":"javascript@runtime:function() { return context.get('request');}","isRequired":true,"uniqueKey":"oneOf.0.request.oneOf.4","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.0.request","typeLabel":"Static Value · object · string · string · string · string"},"response_handler":{"oneOf":[{"type":"string","title":"Static Value","description":"if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.0.response_handler.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{responseHandler}}","isRequired":true,"uniqueKey":"oneOf.0.response_handler.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('responseHandler');}","isRequired":true,"uniqueKey":"oneOf.0.response_handler.oneOf.2","typeLabel":"string"},{"type":"string","title":"Runtime - Handlebars","description":"if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","pattern":"^handlebars@runtime:.*","example":"handlebars@runtime:{{responseHandler}}","isRequired":true,"uniqueKey":"oneOf.0.response_handler.oneOf.3","typeLabel":"string"},{"type":"string","title":"Runtime - Javascript","description":"if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","pattern":"^javascript@runtime:.*","example":"javascript@runtime:function() { return context.get('responseHandler');}","isRequired":true,"uniqueKey":"oneOf.0.response_handler.oneOf.4","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.0.response_handler","typeLabel":"string"},"retry_intervals":{"oneOf":[{"type":"array","items":{"description":"[RFC 5545](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.6) duration string.","example":"PT42S","pattern":"^[-+]?P(?:(?:[-+]?[0-9]+D)(?:T(?=(?:[-+]?[0-9]+H|[-+]?[0-9]+M|[-+]?[0-9]+(?:[.,][0-9]*)?S))(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]*)?S)?)?|T(?=(?:[-+]?[0-9]+H|[-+]?[0-9]+M|[-+]?[0-9]+(?:[.,][0-9]*)?S))(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]*)?S)?)$","type":"string","uniqueKey":"oneOf.0.retry_intervals.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Static Value","description":"The retry intervals as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.0.retry_intervals.oneOf.0","typeLabel":"string[]"},{"type":"string","title":"Buildtime - Handlebars","description":"The retry intervals as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{retryIntervals}}","isRequired":true,"uniqueKey":"oneOf.0.retry_intervals.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The retry intervals as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('retryIntervals');}","isRequired":true,"uniqueKey":"oneOf.0.retry_intervals.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.0.retry_intervals","typeLabel":"string[] · string · string"},"tags":{"items":{"type":"string","uniqueKey":"oneOf.0.tags.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":true,"isRequired":true,"uniqueKey":"oneOf.0.tags","typeLabel":"string[]"},"type":{"type":"string","enum":["CLIENT"],"isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.","example":"2025-10-24T02:00:00-07:00","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\\[[^\\]]+\\])?$","type":"string","isRequired":true,"uniqueKey":"oneOf.0.updated_at","typeLabel":"string"},"url":{"oneOf":[{"type":"string","title":"Static Value","description":"The url as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.0.url.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"The url as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{url}}","isRequired":true,"uniqueKey":"oneOf.0.url.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The url as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('url');}","isRequired":true,"uniqueKey":"oneOf.0.url.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.0.url","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"CLIENT · object"},{"type":"object","title":"GENERIC","description":"Stored generic webhook definition. Fields `name`, `url`, `client_key_id`, `request`, `response_handler`, `enabled`, `description`, `default_method`, and `retry_intervals` are unevaluated and appear in buildtime-evaluatable form.","required":["client_key_id","component_ids","component_references","created_at","default_method","description","enabled","id","name","request","response_handler","retry_intervals","tags","type","updated_at","url"],"properties":{"client_key_id":{"oneOf":[{"type":"string","title":"Static Value","description":"The client key id as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.1.client_key_id.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"The client key id as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{clientKeyId}}","isRequired":true,"uniqueKey":"oneOf.1.client_key_id.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The client key id as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('clientKeyId');}","isRequired":true,"uniqueKey":"oneOf.1.client_key_id.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.1.client_key_id","typeLabel":"string"},"component_ids":{"items":{"type":"string","uniqueKey":"oneOf.1.component_ids.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"oneOf.1.component_ids","typeLabel":"string[]"},"component_references":{"items":{"properties":{"component_id":{"type":"string","uniqueKey":"oneOf.1.component_references.items.[INDEX].component_id","typeLabel":"string"},"socket_names":{"items":{"type":"string","uniqueKey":"oneOf.1.component_references.items.[INDEX].socket_names.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"oneOf.1.component_references.items.[INDEX].socket_names","typeLabel":"string[]"}},"type":"object","uniqueKey":"oneOf.1.component_references.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"oneOf.1.component_references","typeLabel":"object[]"},"created_at":{"description":"[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.","example":"2025-10-24T02:00:00-07:00","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\\[[^\\]]+\\])?$","type":"string","isRequired":true,"uniqueKey":"oneOf.1.created_at","typeLabel":"string"},"default_method":{"oneOf":[{"type":"string","title":"Static Value","description":"The default method as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.1.default_method.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"The default method as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{defaultMethod}}","isRequired":true,"uniqueKey":"oneOf.1.default_method.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The default method as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('defaultMethod');}","isRequired":true,"uniqueKey":"oneOf.1.default_method.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.1.default_method","typeLabel":"string"},"description":{"oneOf":[{"type":"string","title":"Static Value","description":"The description as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"The description as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{description}}","isRequired":true,"uniqueKey":"oneOf.1.description.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The description as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('description');}","isRequired":true,"uniqueKey":"oneOf.1.description.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.1.description","typeLabel":"string"},"enabled":{"oneOf":[{"type":"boolean","title":"Static Value","description":"The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.1.enabled.oneOf.0","typeLabel":"boolean"},{"type":"string","title":"Buildtime - Handlebars","description":"The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{enabled}}","isRequired":true,"uniqueKey":"oneOf.1.enabled.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('enabled');}","isRequired":true,"uniqueKey":"oneOf.1.enabled.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.1.enabled","typeLabel":"boolean · string · string"},"id":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"oneOf.1.id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","title":"Static Value","description":"The name as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"The name as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{name}}","isRequired":true,"uniqueKey":"oneOf.1.name.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The name as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('name');}","isRequired":true,"uniqueKey":"oneOf.1.name.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.1.name","typeLabel":"string"},"request":{"oneOf":[{"type":"object","title":"Static Value","description":"The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).","required":["headers","method","url","urlTemplateParameters"],"properties":{"headers":{"additionalProperties":{"items":{"type":"string","uniqueKey":"oneOf.1.request.oneOf.0.headers.additionalProperties.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"oneOf.1.request.oneOf.0.headers.additionalProperties","typeLabel":"string[]"},"type":"object","isRequired":true,"uniqueKey":"oneOf.1.request.oneOf.0.headers","typeLabel":"object"},"method":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.request.oneOf.0.method","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.request.oneOf.0.url","typeLabel":"string"},"urlTemplateParameters":{"additionalProperties":{"type":"string","uniqueKey":"oneOf.1.request.oneOf.0.urlTemplateParameters.additionalProperties","typeLabel":"string"},"type":"object","isRequired":true,"uniqueKey":"oneOf.1.request.oneOf.0.urlTemplateParameters","typeLabel":"object"},"body":{"oneOf":[{"type":"string","uniqueKey":"oneOf.1.request.oneOf.0.body.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.1.request.oneOf.0.body.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.request.oneOf.0.body","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"oneOf.1.request.oneOf.0","typeLabel":"Static Value · object"},{"type":"string","title":"Buildtime - Handlebars","description":"The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{request}}","isRequired":true,"uniqueKey":"oneOf.1.request.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('request');}","isRequired":true,"uniqueKey":"oneOf.1.request.oneOf.2","typeLabel":"string"},{"type":"string","title":"Runtime - Handlebars","description":"The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).","pattern":"^handlebars@runtime:.*","example":"handlebars@runtime:{{request}}","isRequired":true,"uniqueKey":"oneOf.1.request.oneOf.3","typeLabel":"string"},{"type":"string","title":"Runtime - Javascript","description":"The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).","pattern":"^javascript@runtime:.*","example":"javascript@runtime:function() { return context.get('request');}","isRequired":true,"uniqueKey":"oneOf.1.request.oneOf.4","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.1.request","typeLabel":"Static Value · object · string · string · string · string"},"response_handler":{"oneOf":[{"type":"string","title":"Static Value","description":"if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.1.response_handler.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{responseHandler}}","isRequired":true,"uniqueKey":"oneOf.1.response_handler.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('responseHandler');}","isRequired":true,"uniqueKey":"oneOf.1.response_handler.oneOf.2","typeLabel":"string"},{"type":"string","title":"Runtime - Handlebars","description":"if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","pattern":"^handlebars@runtime:.*","example":"handlebars@runtime:{{responseHandler}}","isRequired":true,"uniqueKey":"oneOf.1.response_handler.oneOf.3","typeLabel":"string"},{"type":"string","title":"Runtime - Javascript","description":"if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","pattern":"^javascript@runtime:.*","example":"javascript@runtime:function() { return context.get('responseHandler');}","isRequired":true,"uniqueKey":"oneOf.1.response_handler.oneOf.4","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.1.response_handler","typeLabel":"string"},"retry_intervals":{"oneOf":[{"type":"array","items":{"description":"[RFC 5545](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.6) duration string.","example":"PT42S","pattern":"^[-+]?P(?:(?:[-+]?[0-9]+D)(?:T(?=(?:[-+]?[0-9]+H|[-+]?[0-9]+M|[-+]?[0-9]+(?:[.,][0-9]*)?S))(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]*)?S)?)?|T(?=(?:[-+]?[0-9]+H|[-+]?[0-9]+M|[-+]?[0-9]+(?:[.,][0-9]*)?S))(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]*)?S)?)$","type":"string","uniqueKey":"oneOf.1.retry_intervals.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Static Value","description":"The retry intervals as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.1.retry_intervals.oneOf.0","typeLabel":"string[]"},{"type":"string","title":"Buildtime - Handlebars","description":"The retry intervals as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{retryIntervals}}","isRequired":true,"uniqueKey":"oneOf.1.retry_intervals.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The retry intervals as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('retryIntervals');}","isRequired":true,"uniqueKey":"oneOf.1.retry_intervals.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.1.retry_intervals","typeLabel":"string[] · string · string"},"tags":{"items":{"type":"string","uniqueKey":"oneOf.1.tags.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":true,"isRequired":true,"uniqueKey":"oneOf.1.tags","typeLabel":"string[]"},"type":{"type":"string","enum":["GENERIC"],"isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.","example":"2025-10-24T02:00:00-07:00","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\\[[^\\]]+\\])?$","type":"string","isRequired":true,"uniqueKey":"oneOf.1.updated_at","typeLabel":"string"},"url":{"oneOf":[{"type":"string","title":"Static Value","description":"The url as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.1.url.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"The url as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{url}}","isRequired":true,"uniqueKey":"oneOf.1.url.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The url as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('url');}","isRequired":true,"uniqueKey":"oneOf.1.url.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.1.url","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"GENERIC · object"},{"type":"object","title":"PARTNER","description":"Stored partner webhook definition. Fields `name`, `url`, `client_key_id`, `request`, `response_handler`, `enabled`, `description`, `default_method`, `retry_intervals`, and `response_body_handler` are unevaluated and appear in buildtime-evaluatable form.","required":["client_key_id","component_ids","component_references","created_at","default_method","description","enabled","id","name","request","response_handler","retry_intervals","tags","type","updated_at","url","response_body_handler"],"properties":{"client_key_id":{"oneOf":[{"type":"string","title":"Static Value","description":"The client key id as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.2.client_key_id.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"The client key id as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{clientKeyId}}","isRequired":true,"uniqueKey":"oneOf.2.client_key_id.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The client key id as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('clientKeyId');}","isRequired":true,"uniqueKey":"oneOf.2.client_key_id.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.2.client_key_id","typeLabel":"string"},"component_ids":{"items":{"type":"string","uniqueKey":"oneOf.2.component_ids.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"oneOf.2.component_ids","typeLabel":"string[]"},"component_references":{"items":{"properties":{"component_id":{"type":"string","uniqueKey":"oneOf.2.component_references.items.[INDEX].component_id","typeLabel":"string"},"socket_names":{"items":{"type":"string","uniqueKey":"oneOf.2.component_references.items.[INDEX].socket_names.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"oneOf.2.component_references.items.[INDEX].socket_names","typeLabel":"string[]"}},"type":"object","uniqueKey":"oneOf.2.component_references.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"oneOf.2.component_references","typeLabel":"object[]"},"created_at":{"description":"[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.","example":"2025-10-24T02:00:00-07:00","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\\[[^\\]]+\\])?$","type":"string","isRequired":true,"uniqueKey":"oneOf.2.created_at","typeLabel":"string"},"default_method":{"oneOf":[{"type":"string","title":"Static Value","description":"The default method as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.2.default_method.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"The default method as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{defaultMethod}}","isRequired":true,"uniqueKey":"oneOf.2.default_method.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The default method as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('defaultMethod');}","isRequired":true,"uniqueKey":"oneOf.2.default_method.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.2.default_method","typeLabel":"string"},"description":{"oneOf":[{"type":"string","title":"Static Value","description":"The description as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.2.description.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"The description as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{description}}","isRequired":true,"uniqueKey":"oneOf.2.description.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The description as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('description');}","isRequired":true,"uniqueKey":"oneOf.2.description.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.2.description","typeLabel":"string"},"enabled":{"oneOf":[{"type":"boolean","title":"Static Value","description":"The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.2.enabled.oneOf.0","typeLabel":"boolean"},{"type":"string","title":"Buildtime - Handlebars","description":"The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{enabled}}","isRequired":true,"uniqueKey":"oneOf.2.enabled.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('enabled');}","isRequired":true,"uniqueKey":"oneOf.2.enabled.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.2.enabled","typeLabel":"boolean · string · string"},"id":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"oneOf.2.id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","title":"Static Value","description":"The name as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.2.name.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"The name as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{name}}","isRequired":true,"uniqueKey":"oneOf.2.name.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The name as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('name');}","isRequired":true,"uniqueKey":"oneOf.2.name.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.2.name","typeLabel":"string"},"request":{"oneOf":[{"type":"object","title":"Static Value","description":"The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).","required":["headers","method","url","urlTemplateParameters"],"properties":{"headers":{"additionalProperties":{"items":{"type":"string","uniqueKey":"oneOf.2.request.oneOf.0.headers.additionalProperties.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"oneOf.2.request.oneOf.0.headers.additionalProperties","typeLabel":"string[]"},"type":"object","isRequired":true,"uniqueKey":"oneOf.2.request.oneOf.0.headers","typeLabel":"object"},"method":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.request.oneOf.0.method","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.request.oneOf.0.url","typeLabel":"string"},"urlTemplateParameters":{"additionalProperties":{"type":"string","uniqueKey":"oneOf.2.request.oneOf.0.urlTemplateParameters.additionalProperties","typeLabel":"string"},"type":"object","isRequired":true,"uniqueKey":"oneOf.2.request.oneOf.0.urlTemplateParameters","typeLabel":"object"},"body":{"oneOf":[{"type":"string","uniqueKey":"oneOf.2.request.oneOf.0.body.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.2.request.oneOf.0.body.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.request.oneOf.0.body","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"oneOf.2.request.oneOf.0","typeLabel":"Static Value · object"},{"type":"string","title":"Buildtime - Handlebars","description":"The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{request}}","isRequired":true,"uniqueKey":"oneOf.2.request.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('request');}","isRequired":true,"uniqueKey":"oneOf.2.request.oneOf.2","typeLabel":"string"},{"type":"string","title":"Runtime - Handlebars","description":"The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).","pattern":"^handlebars@runtime:.*","example":"handlebars@runtime:{{request}}","isRequired":true,"uniqueKey":"oneOf.2.request.oneOf.3","typeLabel":"string"},{"type":"string","title":"Runtime - Javascript","description":"The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).","pattern":"^javascript@runtime:.*","example":"javascript@runtime:function() { return context.get('request');}","isRequired":true,"uniqueKey":"oneOf.2.request.oneOf.4","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.2.request","typeLabel":"Static Value · object · string · string · string · string"},"response_handler":{"oneOf":[{"type":"string","title":"Static Value","description":"if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.2.response_handler.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{responseHandler}}","isRequired":true,"uniqueKey":"oneOf.2.response_handler.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('responseHandler');}","isRequired":true,"uniqueKey":"oneOf.2.response_handler.oneOf.2","typeLabel":"string"},{"type":"string","title":"Runtime - Handlebars","description":"if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","pattern":"^handlebars@runtime:.*","example":"handlebars@runtime:{{responseHandler}}","isRequired":true,"uniqueKey":"oneOf.2.response_handler.oneOf.3","typeLabel":"string"},{"type":"string","title":"Runtime - Javascript","description":"if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","pattern":"^javascript@runtime:.*","example":"javascript@runtime:function() { return context.get('responseHandler');}","isRequired":true,"uniqueKey":"oneOf.2.response_handler.oneOf.4","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.2.response_handler","typeLabel":"string"},"retry_intervals":{"oneOf":[{"type":"array","items":{"description":"[RFC 5545](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.6) duration string.","example":"PT42S","pattern":"^[-+]?P(?:(?:[-+]?[0-9]+D)(?:T(?=(?:[-+]?[0-9]+H|[-+]?[0-9]+M|[-+]?[0-9]+(?:[.,][0-9]*)?S))(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]*)?S)?)?|T(?=(?:[-+]?[0-9]+H|[-+]?[0-9]+M|[-+]?[0-9]+(?:[.,][0-9]*)?S))(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]*)?S)?)$","type":"string","uniqueKey":"oneOf.2.retry_intervals.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Static Value","description":"The retry intervals as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.2.retry_intervals.oneOf.0","typeLabel":"string[]"},{"type":"string","title":"Buildtime - Handlebars","description":"The retry intervals as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{retryIntervals}}","isRequired":true,"uniqueKey":"oneOf.2.retry_intervals.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The retry intervals as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('retryIntervals');}","isRequired":true,"uniqueKey":"oneOf.2.retry_intervals.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.2.retry_intervals","typeLabel":"string[] · string · string"},"tags":{"items":{"type":"string","uniqueKey":"oneOf.2.tags.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":true,"isRequired":true,"uniqueKey":"oneOf.2.tags","typeLabel":"string[]"},"type":{"type":"string","enum":["PARTNER"],"isRequired":true,"uniqueKey":"oneOf.2.type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.","example":"2025-10-24T02:00:00-07:00","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\\[[^\\]]+\\])?$","type":"string","isRequired":true,"uniqueKey":"oneOf.2.updated_at","typeLabel":"string"},"url":{"oneOf":[{"type":"string","title":"Static Value","description":"The url as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.2.url.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"The url as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{url}}","isRequired":true,"uniqueKey":"oneOf.2.url.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The url as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('url');}","isRequired":true,"uniqueKey":"oneOf.2.url.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.2.url","typeLabel":"string"},"response_body_handler":{"oneOf":[{"type":"object","title":"Static Value","description":"The response body handler as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","additionalProperties":{"type":"object","uniqueKey":"oneOf.2.response_body_handler.oneOf.0.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.2.response_body_handler.oneOf.0","typeLabel":"Static Value · object"},{"type":"string","title":"Buildtime - Handlebars","description":"The response body handler as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{responseBodyHandler}}","isRequired":true,"uniqueKey":"oneOf.2.response_body_handler.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The response body handler as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('responseBodyHandler');}","isRequired":true,"uniqueKey":"oneOf.2.response_body_handler.oneOf.2","typeLabel":"string"},{"type":"string","title":"Runtime - Handlebars","description":"The response body handler as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","pattern":"^handlebars@runtime:.*","example":"handlebars@runtime:{{responseBodyHandler}}","isRequired":true,"uniqueKey":"oneOf.2.response_body_handler.oneOf.3","typeLabel":"string"},{"type":"string","title":"Runtime - Javascript","description":"The response body handler as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","pattern":"^javascript@runtime:.*","example":"javascript@runtime:function() { return context.get('responseBodyHandler');}","isRequired":true,"uniqueKey":"oneOf.2.response_body_handler.oneOf.4","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.2.response_body_handler","typeLabel":"Static Value · object · string · string · string · string"}},"uniqueKey":"oneOf.2","typeLabel":"PARTNER · object"},{"type":"object","title":"REWARD","description":"Stored reward webhook definition. Fields `name`, `url`, `client_key_id`, `request`, `response_handler`, `enabled`, `description`, `default_method`, and `retry_intervals` are unevaluated and appear in buildtime-evaluatable form.","required":["client_key_id","component_ids","component_references","created_at","default_method","description","enabled","id","name","request","response_handler","retry_intervals","tags","type","updated_at","url","filters"],"properties":{"client_key_id":{"oneOf":[{"type":"string","title":"Static Value","description":"The client key id as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.3.client_key_id.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"The client key id as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{clientKeyId}}","isRequired":true,"uniqueKey":"oneOf.3.client_key_id.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The client key id as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('clientKeyId');}","isRequired":true,"uniqueKey":"oneOf.3.client_key_id.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.3.client_key_id","typeLabel":"string"},"component_ids":{"items":{"type":"string","uniqueKey":"oneOf.3.component_ids.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"oneOf.3.component_ids","typeLabel":"string[]"},"component_references":{"items":{"properties":{"component_id":{"type":"string","uniqueKey":"oneOf.3.component_references.items.[INDEX].component_id","typeLabel":"string"},"socket_names":{"items":{"type":"string","uniqueKey":"oneOf.3.component_references.items.[INDEX].socket_names.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"oneOf.3.component_references.items.[INDEX].socket_names","typeLabel":"string[]"}},"type":"object","uniqueKey":"oneOf.3.component_references.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"oneOf.3.component_references","typeLabel":"object[]"},"created_at":{"description":"[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.","example":"2025-10-24T02:00:00-07:00","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\\[[^\\]]+\\])?$","type":"string","isRequired":true,"uniqueKey":"oneOf.3.created_at","typeLabel":"string"},"default_method":{"oneOf":[{"type":"string","title":"Static Value","description":"The default method as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.3.default_method.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"The default method as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{defaultMethod}}","isRequired":true,"uniqueKey":"oneOf.3.default_method.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The default method as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('defaultMethod');}","isRequired":true,"uniqueKey":"oneOf.3.default_method.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.3.default_method","typeLabel":"string"},"description":{"oneOf":[{"type":"string","title":"Static Value","description":"The description as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.3.description.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"The description as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{description}}","isRequired":true,"uniqueKey":"oneOf.3.description.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The description as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('description');}","isRequired":true,"uniqueKey":"oneOf.3.description.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.3.description","typeLabel":"string"},"enabled":{"oneOf":[{"type":"boolean","title":"Static Value","description":"The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.3.enabled.oneOf.0","typeLabel":"boolean"},{"type":"string","title":"Buildtime - Handlebars","description":"The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{enabled}}","isRequired":true,"uniqueKey":"oneOf.3.enabled.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('enabled');}","isRequired":true,"uniqueKey":"oneOf.3.enabled.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.3.enabled","typeLabel":"boolean · string · string"},"id":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"oneOf.3.id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","title":"Static Value","description":"The name as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.3.name.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"The name as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{name}}","isRequired":true,"uniqueKey":"oneOf.3.name.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The name as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('name');}","isRequired":true,"uniqueKey":"oneOf.3.name.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.3.name","typeLabel":"string"},"request":{"oneOf":[{"type":"object","title":"Static Value","description":"The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).","required":["headers","method","url","urlTemplateParameters"],"properties":{"headers":{"additionalProperties":{"items":{"type":"string","uniqueKey":"oneOf.3.request.oneOf.0.headers.additionalProperties.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"oneOf.3.request.oneOf.0.headers.additionalProperties","typeLabel":"string[]"},"type":"object","isRequired":true,"uniqueKey":"oneOf.3.request.oneOf.0.headers","typeLabel":"object"},"method":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.request.oneOf.0.method","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.request.oneOf.0.url","typeLabel":"string"},"urlTemplateParameters":{"additionalProperties":{"type":"string","uniqueKey":"oneOf.3.request.oneOf.0.urlTemplateParameters.additionalProperties","typeLabel":"string"},"type":"object","isRequired":true,"uniqueKey":"oneOf.3.request.oneOf.0.urlTemplateParameters","typeLabel":"object"},"body":{"oneOf":[{"type":"string","uniqueKey":"oneOf.3.request.oneOf.0.body.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.3.request.oneOf.0.body.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.3.request.oneOf.0.body","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"oneOf.3.request.oneOf.0","typeLabel":"Static Value · object"},{"type":"string","title":"Buildtime - Handlebars","description":"The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{request}}","isRequired":true,"uniqueKey":"oneOf.3.request.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('request');}","isRequired":true,"uniqueKey":"oneOf.3.request.oneOf.2","typeLabel":"string"},{"type":"string","title":"Runtime - Handlebars","description":"The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).","pattern":"^handlebars@runtime:.*","example":"handlebars@runtime:{{request}}","isRequired":true,"uniqueKey":"oneOf.3.request.oneOf.3","typeLabel":"string"},{"type":"string","title":"Runtime - Javascript","description":"The request as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).","pattern":"^javascript@runtime:.*","example":"javascript@runtime:function() { return context.get('request');}","isRequired":true,"uniqueKey":"oneOf.3.request.oneOf.4","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.3.request","typeLabel":"Static Value · object · string · string · string · string"},"response_handler":{"oneOf":[{"type":"string","title":"Static Value","description":"if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.3.response_handler.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{responseHandler}}","isRequired":true,"uniqueKey":"oneOf.3.response_handler.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('responseHandler');}","isRequired":true,"uniqueKey":"oneOf.3.response_handler.oneOf.2","typeLabel":"string"},{"type":"string","title":"Runtime - Handlebars","description":"if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","pattern":"^handlebars@runtime:.*","example":"handlebars@runtime:{{responseHandler}}","isRequired":true,"uniqueKey":"oneOf.3.response_handler.oneOf.3","typeLabel":"string"},{"type":"string","title":"Runtime - Javascript","description":"if no webhook response status is provided, we will retry non 2xx webhook requests. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). Runtime expressions use [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).","pattern":"^javascript@runtime:.*","example":"javascript@runtime:function() { return context.get('responseHandler');}","isRequired":true,"uniqueKey":"oneOf.3.response_handler.oneOf.4","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.3.response_handler","typeLabel":"string"},"retry_intervals":{"oneOf":[{"type":"array","items":{"description":"[RFC 5545](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.6) duration string.","example":"PT42S","pattern":"^[-+]?P(?:(?:[-+]?[0-9]+D)(?:T(?=(?:[-+]?[0-9]+H|[-+]?[0-9]+M|[-+]?[0-9]+(?:[.,][0-9]*)?S))(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]*)?S)?)?|T(?=(?:[-+]?[0-9]+H|[-+]?[0-9]+M|[-+]?[0-9]+(?:[.,][0-9]*)?S))(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]*)?S)?)$","type":"string","uniqueKey":"oneOf.3.retry_intervals.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Static Value","description":"The retry intervals as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.3.retry_intervals.oneOf.0","typeLabel":"string[]"},{"type":"string","title":"Buildtime - Handlebars","description":"The retry intervals as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{retryIntervals}}","isRequired":true,"uniqueKey":"oneOf.3.retry_intervals.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The retry intervals as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('retryIntervals');}","isRequired":true,"uniqueKey":"oneOf.3.retry_intervals.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.3.retry_intervals","typeLabel":"string[] · string · string"},"tags":{"items":{"type":"string","uniqueKey":"oneOf.3.tags.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":true,"isRequired":true,"uniqueKey":"oneOf.3.tags","typeLabel":"string[]"},"type":{"type":"string","enum":["REWARD"],"isRequired":true,"uniqueKey":"oneOf.3.type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.","example":"2025-10-24T02:00:00-07:00","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\\[[^\\]]+\\])?$","type":"string","isRequired":true,"uniqueKey":"oneOf.3.updated_at","typeLabel":"string"},"url":{"oneOf":[{"type":"string","title":"Static Value","description":"The url as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","isRequired":true,"uniqueKey":"oneOf.3.url.oneOf.0","typeLabel":"string"},{"type":"string","title":"Buildtime - Handlebars","description":"The url as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^handlebars@buildtime:.*","example":"handlebars@buildtime:{{url}}","isRequired":true,"uniqueKey":"oneOf.3.url.oneOf.1","typeLabel":"string"},{"type":"string","title":"Buildtime - Javascript","description":"The url as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).","pattern":"^javascript@buildtime:.*","example":"javascript@buildtime:function() { return context.getVariableContext().get('url');}","isRequired":true,"uniqueKey":"oneOf.3.url.oneOf.2","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.3.url","typeLabel":"string"},"filters":{"items":{"properties":{"created_at":{"description":"[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.","example":"2025-10-24T02:00:00-07:00","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\\[[^\\]]+\\])?$","type":"string","isRequired":true,"uniqueKey":"oneOf.3.filters.items.[INDEX].created_at","typeLabel":"string"},"id":{"readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.3.filters.items.[INDEX].id","typeLabel":"string"},"type":{"enum":["EXPRESSION","STATE","SUPPLIER","TAGS"],"type":"string","isRequired":true,"uniqueKey":"oneOf.3.filters.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.","example":"2025-10-24T02:00:00-07:00","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\\[[^\\]]+\\])?$","type":"string","isRequired":true,"uniqueKey":"oneOf.3.filters.items.[INDEX].updated_at","typeLabel":"string"}},"required":["created_at","id","type","updated_at"],"type":"object","uniqueKey":"oneOf.3.filters.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"oneOf.3.filters","typeLabel":"object[]"}},"uniqueKey":"oneOf.3","typeLabel":"REWARD · object"}],"uniqueKey":"","typeLabel":"CLIENT · object | GENERIC · object | PARTNER · object | REWARD · object"},"examples":{"Example":{"title":"Example","value":{"client_key_id":"\u003cstring>","component_ids":["\u003cstring>"],"component_references":[{"component_id":"\u003cstring>","socket_names":["\u003cstring>"]}],"created_at":"2025-10-24T02:00:00-07:00","default_method":"\u003cstring>","description":"\u003cstring>","enabled":true,"id":"\u003cstring>","name":"\u003cstring>","request":{"headers":{},"method":"\u003cstring>","url":"\u003cstring>","urlTemplateParameters":{},"body":"\u003cstring>"},"response_handler":"\u003cstring>","retry_intervals":["PT42S"],"tags":["\u003cstring>"],"type":"CLIENT","updated_at":"2025-10-24T02:00:00-07:00","url":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Webhook definition.","exampleType":"generated"},"f9bbf47e-5c19-45cc-b5a8-395d04574f11":{"content":{"application/json":{"examples":{"webhook_not_found":{"title":"webhook_not_found","value":{"code":"webhook_not_found","http_status_code":400,"message":"Was unable to find webhook with id","parameters":{},"unique_id":"00000000-0000-0000-0000-000000000000"}}},"schema":{"description":"Represents the API error response","properties":{"code":{"description":"Specific error code for this error type, documented per endpoint","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"http_status_code":{"description":"HTTP status code that was returned with this error, useful if client get response code","format":"int32","type":"integer","isRequired":true,"uniqueKey":"http_status_code","typeLabel":"integer\u003cint32>"},"message":{"description":"User readable English description of the error","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"parameters":{"additionalProperties":{"description":"Attributes related to the error, varies be error code, documented per endpoint","type":"object","uniqueKey":"parameters.additionalProperties","typeLabel":"object"},"description":"Attributes related to the error, varies be error code, documented per endpoint","type":"object","isRequired":true,"uniqueKey":"parameters","typeLabel":"object"},"unique_id":{"description":"Unique id associated with this error, useful for discussions with Extole","type":"string","isRequired":true,"uniqueKey":"unique_id","typeLabel":"string"}},"required":["code","http_status_code","message","parameters","unique_id"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Webhook was not found. The supplied id does not match any webhook accessible to the calling client.","exampleType":"examples"},"5862247a-4fa5-4e2d-b592-3d782aa4c999":{"content":{"application/json":{"examples":{"method_unauthorized":{"title":"method_unauthorized","value":{"code":"method_unauthorized","http_status_code":401,"message":"Unauthorized access to this endpoint","parameters":{},"unique_id":"00000000-0000-0000-0000-000000000000"}}},"schema":{"description":"Represents the API error response","properties":{"code":{"description":"Specific error code for this error type, documented per endpoint","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"http_status_code":{"description":"HTTP status code that was returned with this error, useful if client get response code","format":"int32","type":"integer","isRequired":true,"uniqueKey":"http_status_code","typeLabel":"integer\u003cint32>"},"message":{"description":"User readable English description of the error","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"parameters":{"additionalProperties":{"description":"Attributes related to the error, varies be error code, documented per endpoint","type":"object","uniqueKey":"parameters.additionalProperties","typeLabel":"object"},"description":"Attributes related to the error, varies be error code, documented per endpoint","type":"object","isRequired":true,"uniqueKey":"parameters","typeLabel":"object"},"unique_id":{"description":"Unique id associated with this error, useful for discussions with Extole","type":"string","isRequired":true,"uniqueKey":"unique_id","typeLabel":"string"}},"required":["code","http_status_code","message","parameters","unique_id"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Unauthorized","exampleType":"examples"},"412564cc-f647-4929-83ac-062d8a50b1fc":{"content":{"application/json":{"examples":{"payment_required":{"title":"payment_required","value":{"code":"payment_required","http_status_code":402,"message":"The access_token provided is associated with an unpaid account.","parameters":{},"unique_id":"00000000-0000-0000-0000-000000000000"}}},"schema":{"description":"Represents the API error response","properties":{"code":{"description":"Specific error code for this error type, documented per endpoint","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"http_status_code":{"description":"HTTP status code that was returned with this error, useful if client get response code","format":"int32","type":"integer","isRequired":true,"uniqueKey":"http_status_code","typeLabel":"integer\u003cint32>"},"message":{"description":"User readable English description of the error","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"parameters":{"additionalProperties":{"description":"Attributes related to the error, varies be error code, documented per endpoint","type":"object","uniqueKey":"parameters.additionalProperties","typeLabel":"object"},"description":"Attributes related to the error, varies be error code, documented per endpoint","type":"object","isRequired":true,"uniqueKey":"parameters","typeLabel":"object"},"unique_id":{"description":"Unique id associated with this error, useful for discussions with Extole","type":"string","isRequired":true,"uniqueKey":"unique_id","typeLabel":"string"}},"required":["code","http_status_code","message","parameters","unique_id"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Payment Required","exampleType":"examples"},"38cee6f7-8931-4b8d-b1c2-e3489d27f439":{"content":{"application/json":{"examples":{"access_denied":{"title":"access_denied","value":{"code":"access_denied","http_status_code":403,"message":"The access_token provided is not permitted to access the specified resource.","parameters":{},"unique_id":"00000000-0000-0000-0000-000000000000"}},"method_unauthorized":{"title":"method_unauthorized","value":{"code":"method_unauthorized","http_status_code":401,"message":"Unauthorized access to this endpoint","parameters":{},"unique_id":"00000000-0000-0000-0000-000000000000"}},"missing_access_token":{"title":"missing_access_token","value":{"code":"missing_access_token","http_status_code":403,"message":"No access_token was provided with this request.","parameters":{},"unique_id":"00000000-0000-0000-0000-000000000000"}}},"schema":{"description":"Represents the API error response","properties":{"code":{"description":"Specific error code for this error type, documented per endpoint","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"http_status_code":{"description":"HTTP status code that was returned with this error, useful if client get response code","format":"int32","type":"integer","isRequired":true,"uniqueKey":"http_status_code","typeLabel":"integer\u003cint32>"},"message":{"description":"User readable English description of the error","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"parameters":{"additionalProperties":{"description":"Attributes related to the error, varies be error code, documented per endpoint","type":"object","uniqueKey":"parameters.additionalProperties","typeLabel":"object"},"description":"Attributes related to the error, varies be error code, documented per endpoint","type":"object","isRequired":true,"uniqueKey":"parameters","typeLabel":"object"},"unique_id":{"description":"Unique id associated with this error, useful for discussions with Extole","type":"string","isRequired":true,"uniqueKey":"unique_id","typeLabel":"string"}},"required":["code","http_status_code","message","parameters","unique_id"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Forbidden","exampleType":"examples"},"3ee040ed-137e-4c57-b599-d1be53b8bc61":{"content":{"application/json":{"examples":{"unsupported_media_type":{"title":"unsupported_media_type","value":{"code":"unsupported_media_type","http_status_code":415,"message":"Request had an unsupported or no media type","parameters":{},"unique_id":"00000000-0000-0000-0000-000000000000"}}},"schema":{"description":"Represents the API error response","properties":{"code":{"description":"Specific error code for this error type, documented per endpoint","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"http_status_code":{"description":"HTTP status code that was returned with this error, useful if client get response code","format":"int32","type":"integer","isRequired":true,"uniqueKey":"http_status_code","typeLabel":"integer\u003cint32>"},"message":{"description":"User readable English description of the error","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"parameters":{"additionalProperties":{"description":"Attributes related to the error, varies be error code, documented per endpoint","type":"object","uniqueKey":"parameters.additionalProperties","typeLabel":"object"},"description":"Attributes related to the error, varies be error code, documented per endpoint","type":"object","isRequired":true,"uniqueKey":"parameters","typeLabel":"object"},"unique_id":{"description":"Unique id associated with this error, useful for discussions with Extole","type":"string","isRequired":true,"uniqueKey":"unique_id","typeLabel":"string"}},"required":["code","http_status_code","message","parameters","unique_id"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Unsupported Media Type","exampleType":"examples"},"d4171a97-867e-447b-a83a-a0538e711233":{"content":{"application/json":{"examples":{"too_many_requests":{"title":"too_many_requests","value":{"code":"too_many_requests","http_status_code":429,"message":"The server is unable to process your request at the moment, please retry later.","parameters":{},"unique_id":"00000000-0000-0000-0000-000000000000"}}},"schema":{"description":"Represents the API error response","properties":{"code":{"description":"Specific error code for this error type, documented per endpoint","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"http_status_code":{"description":"HTTP status code that was returned with this error, useful if client get response code","format":"int32","type":"integer","isRequired":true,"uniqueKey":"http_status_code","typeLabel":"integer\u003cint32>"},"message":{"description":"User readable English description of the error","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"parameters":{"additionalProperties":{"description":"Attributes related to the error, varies be error code, documented per endpoint","type":"object","uniqueKey":"parameters.additionalProperties","typeLabel":"object"},"description":"Attributes related to the error, varies be error code, documented per endpoint","type":"object","isRequired":true,"uniqueKey":"parameters","typeLabel":"object"},"unique_id":{"description":"Unique id associated with this error, useful for discussions with Extole","type":"string","isRequired":true,"uniqueKey":"unique_id","typeLabel":"string"}},"required":["code","http_status_code","message","parameters","unique_id"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Too Many Requests","exampleType":"examples"}},"security":{"91f5e9e9-c7e0-44a0-8a13-0d0c8ba2f0e8":{"HEADER":{"in":"header","name":"Authorization","type":"apiKey","x-bearer-format":"bearer","scopes":[],"schemeName":"HEADER"}},"caafc15f-442e-4dec-8558-8aadb3968b74":{"QUERY":{"in":"query","name":"access_token","type":"apiKey","scopes":[],"schemeName":"QUERY"}},"a66f474d-bd77-4222-b723-0f93edbc195b":{"COOKIE":{"in":"cookie","name":"extole_token","type":"apiKey","scopes":[],"schemeName":"COOKIE"}}},"servers":{"2e4faa6f-8cce-47ce-a111-236281ef5887":{"description":"Production","url":"https://api.extole.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"in":"header","name":"Authorization","type":"apiKey","x-bearer-format":"bearer","scopes":[],"schemeName":"HEADER"},"schema":{"title":"Authorization","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"HEADER","name":"Authorization"}],"title":"HEADER"},{"schemes":[{"scheme":{"in":"query","name":"access_token","type":"apiKey","scopes":[],"schemeName":"QUERY"},"schema":{"title":"access_token","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"QUERY","name":"access_token"}],"title":"QUERY"},{"schemes":[{"scheme":{"in":"cookie","name":"extole_token","type":"apiKey","scopes":[],"schemeName":"COOKIE"},"schema":{"title":"extole_token","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"COOKIE","name":"extole_token"}],"title":"COOKIE"}]},"originalFileLocation":"api-reference/management.json"},"subdomain":"extole","siteName":"Extole Documentation","title":"Get a webhook - Extole Documentation","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T13:57:33.225Z","originalFileLocation":"api-reference/webhooks/get-a-webhook.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns the source definition of the supplied webhook, including its URL, headers, event filters, and state. Returns 400 webhook_not_found if the id does not exist or is not accessible.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Extole Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/extole/fqJbsSkQuI9X8tIY/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/extole/fqJbsSkQuI9X8tIY/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/extole/fqJbsSkQuI9X8tIY/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/extole/fqJbsSkQuI9X8tIY/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/extole/fqJbsSkQuI9X8tIY/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/extole/fqJbsSkQuI9X8tIY/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/extole/fqJbsSkQuI9X8tIY/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/extole/fqJbsSkQuI9X8tIY/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/extole/fqJbsSkQuI9X8tIY/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a webhook - Extole Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the source definition of the supplied webhook, including its URL, headers, event filters, and state. Returns 400 webhook_not_found if the id does not exist or is not accessible.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Extole Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.extole.com/api-reference/webhooks/get-a-webhook\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://extole.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Get+a+webhook\u0026amp;description=Returns+the+source+definition+of+the+supplied+webhook%2C+including+its+URL%2C+headers%2C+event+filters%2C+and+state.+Returns+%60400+webhook_not_found%60+if+the+id+does+not+\u0026amp;theme=1484b4628d2fbfb7ddbdf997\u0026amp;signature=f85fa0c4b3464b8c958b8de1e4586936299d3f79ef1296cf0742953d2d7f94b1\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get a webhook - Extole Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the source definition of the supplied webhook, including its URL, headers, event filters, and state. Returns 400 webhook_not_found if the id does not exist or is not accessible.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://extole.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Get+a+webhook\u0026amp;description=Returns+the+source+definition+of+the+supplied+webhook%2C+including+its+URL%2C+headers%2C+event+filters%2C+and+state.+Returns+%60400+webhook_not_found%60+if+the+id+does+not+\u0026amp;theme=1484b4628d2fbfb7ddbdf997\u0026amp;signature=f85fa0c4b3464b8c958b8de1e4586936299d3f79ef1296cf0742953d2d7f94b1\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/extole/fqJbsSkQuI9X8tIY/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Extole Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ee0049\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.extole.com/api-reference/webhooks/get-a-webhook\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/webhooks/get-a-webhook.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.extole.com/#organization\",\"name\":\"Extole Documentation\",\"url\":\"https://docs.extole.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/extole/qEcOgc0BuXrP2LAU/extole-logo.png?fit=max\u0026auto=format\u0026n=qEcOgc0BuXrP2LAU\u0026q=85\u0026s=d7152863dcc1c598d4fac27f91b3658e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.extole.com#website\",\"name\":\"Extole Documentation\",\"url\":\"https://docs.extole.com\",\"publisher\":{\"@id\":\"https://docs.extole.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.extole.com/api-reference/webhooks/get-a-webhook#webpage\",\"url\":\"https://docs.extole.com/api-reference/webhooks/get-a-webhook\",\"name\":\"Get a webhook\",\"description\":\"Returns the source definition of the supplied webhook, including its URL, headers, event filters, and state. Returns 400 webhook_not_found if the id does not exist or is not accessible.\",\"dateModified\":\"2026-11-09T13:57:33.225Z\",\"isPartOf\":{\"@id\":\"https://docs.extole.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.extole.com/api-reference/webhooks/get-a-webhook#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.extole.com/api-reference/webhooks/get-a-webhook#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Management API\",\"item\":\"https://docs.extole.com/api-reference/audiences/list-audiences\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Webhooks\",\"item\":\"https://docs.extole.com/api-reference/webhooks/list-webhooks\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a webhook\",\"item\":\"https://docs.extole.com/api-reference/webhooks/get-a-webhook\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.extole.com/api-reference/webhooks/get-a-webhook#apireference\",\"headline\":\"Get a webhook\",\"name\":\"Get a webhook\",\"description\":\"Returns the source definition of the supplied webhook, including its URL, headers, event filters, and state. Returns 400 webhook_not_found if the id does not exist or is not accessible.\",\"url\":\"https://docs.extole.com/api-reference/webhooks/get-a-webhook\",\"mainEntityOfPage\":{\"@id\":\"https://docs.extole.com/api-reference/webhooks/get-a-webhook#webpage\"},\"dateModified\":\"2026-11-09T13:57:33.225Z\",\"publisher\":{\"@id\":\"https://docs.extole.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.extole.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Extole Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Extole Documentation","nav":{"global":null,"tabs":[{"tab":"Product Docs","pages":[{"title":"Product Docs","href":"/product/extole-overview/what-is-extole"}]},{"tab":"Technical Docs","pages":[{"title":"Technical Docs","href":"/technical/integration-overview/integrating-with-extole"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/platform-overview/extole-chat/troubleshooting"}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"API Overview","href":"/api-reference/getting-started/api-overview"},{"title":"Authentication","href":"/api-reference/getting-started/authentication-overview"},{"title":"Errors","href":"/api-reference/getting-started/common-errors"},{"title":"Feature Specific APIs","tag":"BETA","href":"/api-reference/getting-started/feature-specific-apis"}]},{"group":"Consumer to Extole API","pages":[{"group":"Authentication","pages":[{"title":"Get consumer token details","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v5/token","href":"/api-reference/authentication/get-consumer-token-details"},{"title":"Create a consumer access token","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json post /api/v5/token","href":"/api-reference/authentication/create-a-consumer-access-token"},{"title":"Delete a consumer access token","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json delete /api/v5/token","href":"/api-reference/authentication/delete-a-consumer-access-token"}]},{"group":"Content","pages":[{"title":"Render a zone","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json post /api/v6/zones","href":"/api-reference/content/render-a-zone"},{"title":"Render a named zone","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json post /api/v6/zones/{event_name}","href":"/api-reference/content/render-a-named-zone"},{"title":"Render a zone with the name in the body","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json post /zones","href":"/api-reference/content/render-a-zone-with-the-name-in-the-body"},{"title":"Render a named zone for web-page embedding","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json post /zones/{zone_name}","href":"/api-reference/content/render-a-named-zone-for-web-page-embedding"}]},{"group":"Events","pages":[{"title":"Submit a consumer event by URL","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /events/{event_name}","href":"/api-reference/events/submit-a-consumer-event-by-url"}]},{"group":"Profiles","pages":[{"title":"Get the authenticated consumer profile","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v4/me","href":"/api-reference/profiles/get-the-authenticated-consumer-profile"},{"title":"Update the authenticated consumer profile","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json post /api/v4/me","href":"/api-reference/profiles/update-the-authenticated-consumer-profile"},{"title":"List assets for the authenticated consumer","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v4/me/assets","href":"/api-reference/profiles/list-assets-for-the-authenticated-consumer"},{"title":"Create an asset for the authenticated consumer","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json post /api/v4/me/assets","href":"/api-reference/profiles/create-an-asset-for-the-authenticated-consumer"},{"title":"Download an asset by name","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v4/me/assets/download","href":"/api-reference/profiles/download-an-asset-by-name"},{"title":"Get an asset by ID","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v4/me/assets/{assetId}","href":"/api-reference/profiles/get-an-asset-by-id"},{"title":"Delete an asset by ID","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json delete /api/v4/me/assets/{assetId}","href":"/api-reference/profiles/delete-an-asset-by-id"},{"title":"Download an asset by ID","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v4/me/assets/{assetId}/download","href":"/api-reference/profiles/download-an-asset-by-id"},{"title":"List audience memberships","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v4/me/audience-memberships","href":"/api-reference/profiles/list-audience-memberships"},{"title":"List journeys for the authenticated consumer","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v4/me/journeys","href":"/api-reference/profiles/list-journeys-for-the-authenticated-consumer"},{"title":"Get profile parameters for the authenticated consumer","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v4/me/parameters","href":"/api-reference/profiles/get-profile-parameters-for-the-authenticated-consumer"},{"title":"Update multiple profile parameters","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json post /api/v4/me/parameters","href":"/api-reference/profiles/update-multiple-profile-parameters"},{"title":"List referrals from the authenticated consumer","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v4/me/referrals-from-me","href":"/api-reference/profiles/list-referrals-from-the-authenticated-consumer"},{"title":"List referrals to the authenticated consumer","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v4/me/referrals-to-me","href":"/api-reference/profiles/list-referrals-to-the-authenticated-consumer"},{"title":"Get reward redemption status","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v4/me/rewards/status","href":"/api-reference/profiles/get-reward-redemption-status"},{"title":"List shares for the authenticated consumer","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v4/me/shares","href":"/api-reference/profiles/list-shares-for-the-authenticated-consumer"},{"title":"Get a share by ID for the current consumer","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v4/me/shares/{shareId}","href":"/api-reference/profiles/get-a-share-by-id-for-the-current-consumer"},{"title":"List steps for the authenticated consumer","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v4/me/steps","href":"/api-reference/profiles/list-steps-for-the-authenticated-consumer"},{"title":"List assets for a person","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v4/persons/{personId}/assets","href":"/api-reference/profiles/list-assets-for-a-person"},{"title":"Download a person asset by name","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v4/persons/{personId}/assets/download","href":"/api-reference/profiles/download-a-person-asset-by-name"},{"title":"Get a person asset by ID","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v4/persons/{personId}/assets/{assetId}","href":"/api-reference/profiles/get-a-person-asset-by-id"},{"title":"Download a person asset by asset ID","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v4/persons/{personId}/assets/{assetId}/download","href":"/api-reference/profiles/download-a-person-asset-by-asset-id"},{"title":"List shareables for the authenticated consumer","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v6/me/shareables","href":"/api-reference/profiles/list-shareables-for-the-authenticated-consumer"},{"title":"Create a shareable for the authenticated consumer","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json post /api/v6/me/shareables","href":"/api-reference/profiles/create-a-shareable-for-the-authenticated-consumer"},{"title":"Get a shareable by code","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json get /api/v6/me/shareables/{code}","href":"/api-reference/profiles/get-a-shareable-by-code"},{"title":"Get, create, or update a shareable","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json post /api/v6/me/shareables/get-create-or-update","href":"/api-reference/profiles/get-create-or-update-a-shareable"},{"title":"Get or create a shareable","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json post /api/v6/me/shareables/get-or-create","href":"/api-reference/profiles/get-or-create-a-shareable"},{"title":"Set a single profile parameter","deprecated":null,"version":null,"openapi":"/api-reference/integration-consumer-to-extole.json put /api/v4/me/parameters/{parameter_name}","href":"/api-reference/profiles/set-a-single-profile-parameter"}]}]},{"group":"Server to Extole API","pages":[{"group":"Authentication","pages":[{"title":"Get current access token","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v4/tokens","href":"/api-reference/authentication/get-current-access-token"},{"title":"Create access token","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v4/tokens","href":"/api-reference/authentication/create-access-token"},{"title":"Invalidate current access token","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json delete /v4/tokens","href":"/api-reference/authentication/invalidate-current-access-token"},{"title":"Get access token by value","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v4/tokens/{token}","href":"/api-reference/authentication/get-access-token-by-value"},{"title":"Invalidate access token","deprecated":true,"version":null,"openapi":"/api-reference/integration-server-to-extole.json delete /v4/tokens/{token}","href":"/api-reference/authentication/invalidate-access-token"},{"title":"Exchange access token","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json put /v4/tokens/exchange/{token}","href":"/api-reference/authentication/exchange-access-token"}]},{"group":"Content","pages":[{"title":"Fetch a rendered zone","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/zones/{zone_name}","href":"/api-reference/content/fetch-a-rendered-zone"},{"title":"Render a zone with targeting data","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v5/zones/{zone_name}","href":"/api-reference/content/render-a-zone-with-targeting-data"},{"title":"Render a zone with the name and targeting data in the body","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v5/zones","href":"/api-reference/content/render-a-zone-with-the-name-and-targeting-data-in-the-body"}]},{"group":"Events","pages":[{"title":"Submit an event asynchronously","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v6/async-events","href":"/api-reference/events/submit-an-event-asynchronously"},{"title":"Submit a named event asynchronously","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v6/async-events/{event_name}","href":"/api-reference/events/submit-a-named-event-asynchronously"},{"title":"Submit an event","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v6/events","href":"/api-reference/events/submit-an-event"},{"title":"Submit a named event","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v6/events/{event_name}","href":"/api-reference/events/submit-a-named-event"}]},{"group":"Files","pages":[{"title":"List file assets","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v6/files","href":"/api-reference/files/list-file-assets"},{"title":"Upload a file asset","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v6/files","href":"/api-reference/files/upload-a-file-asset"},{"title":"Get a file asset","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v6/files/{fileId}","href":"/api-reference/files/get-a-file-asset"},{"title":"Update a file asset","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json put /v6/files/{fileId}","href":"/api-reference/files/update-a-file-asset"},{"title":"Delete a file asset","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json delete /v6/files/{fileId}","href":"/api-reference/files/delete-a-file-asset"},{"title":"Download a file asset","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v6/files/{fileId}/download","href":"/api-reference/files/download-a-file-asset"},{"title":"Expire a file asset","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v6/files/{fileId}/expire","href":"/api-reference/files/expire-a-file-asset"}]},{"group":"Persons","pages":[{"title":"Search for persons","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/persons","href":"/api-reference/persons/search-for-persons"},{"title":"Create a person","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v5/persons","href":"/api-reference/persons/create-a-person"},{"title":"List partner keys","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/persons/partner-keys","href":"/api-reference/persons/list-partner-keys"},{"title":"Get a person","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/persons/{person_id}","href":"/api-reference/persons/get-a-person"},{"title":"Update a person","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json put /v5/persons/{person_id}","href":"/api-reference/persons/update-a-person"},{"title":"Get person block status","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/persons/{person_id}/block","href":"/api-reference/persons/get-person-block-status"},{"title":"Update person block status","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json put /v5/persons/{person_id}/block","href":"/api-reference/persons/update-person-block-status"},{"title":"List person data parameters","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/persons/{person_id}/data","href":"/api-reference/persons/list-person-data-parameters"},{"title":"Create a person data parameter","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v5/persons/{person_id}/data","href":"/api-reference/persons/create-a-person-data-parameter"},{"title":"Get a person data parameter","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/persons/{person_id}/data/{name}","href":"/api-reference/persons/get-a-person-data-parameter"},{"title":"Update a person data parameter","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json put /v5/persons/{person_id}/data/{name}","href":"/api-reference/persons/update-a-person-data-parameter"},{"title":"Delete a person data parameter","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json delete /v5/persons/{person_id}/data/{name}","href":"/api-reference/persons/delete-a-person-data-parameter"},{"title":"List the devices that claimed a person's identity","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/persons/{person_id}/device-history","href":"/api-reference/persons/list-the-devices-that-claimed-a-persons-identity"},{"title":"Get identity history for a person","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/persons/{person_id}/identity-history","href":"/api-reference/persons/get-identity-history-for-a-person"},{"title":"List person journeys","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/persons/{person_id}/journeys","href":"/api-reference/persons/list-person-journeys"},{"title":"Get a person journey","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/persons/{person_id}/journeys/{journey_id}","href":"/api-reference/persons/get-a-person-journey"},{"title":"List person locations","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/persons/{person_id}/locations","href":"/api-reference/persons/list-person-locations"},{"title":"List person audience memberships","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/persons/{person_id}/memberships","href":"/api-reference/persons/list-person-audience-memberships"},{"title":"Create a person audience membership","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v5/persons/{person_id}/memberships","href":"/api-reference/persons/create-a-person-audience-membership"},{"title":"List person relationships","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/persons/{person_id}/relationships","href":"/api-reference/persons/list-person-relationships"},{"title":"List person rewards","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/persons/{person_id}/rewards","href":"/api-reference/persons/list-person-rewards"},{"title":"Get a person reward","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/persons/{person_id}/rewards/{reward_id}","href":"/api-reference/persons/get-a-person-reward"},{"title":"List person shareables","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/persons/{person_id}/shareables","href":"/api-reference/persons/list-person-shareables"},{"title":"Create a person shareable","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v5/persons/{person_id}/shareables","href":"/api-reference/persons/create-a-person-shareable"},{"title":"Get a person shareable","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/persons/{person_id}/shareables/{code}","href":"/api-reference/persons/get-a-person-shareable"},{"title":"Update a person shareable","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json put /v5/persons/{person_id}/shareables/{code}","href":"/api-reference/persons/update-a-person-shareable"},{"title":"List person shares","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/persons/{person_id}/shares","href":"/api-reference/persons/list-person-shares"},{"title":"Get a person share","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/persons/{person_id}/shares/{share_id}","href":"/api-reference/persons/get-a-person-share"},{"title":"List person steps","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v5/persons/{person_id}/steps","href":"/api-reference/persons/list-person-steps"},{"title":"Forward an identity profile to another identity profile","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v5/persons/{person_id}/forward","href":"/api-reference/persons/forward-an-identity-profile-to-another-identity-profile"},{"title":"Delete a person audience membership","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json delete /v5/persons/{person_id}/memberships/{audience_id}","href":"/api-reference/persons/delete-a-person-audience-membership"}]},{"group":"Rewards","pages":[{"title":"List rewards","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v2/rewards","href":"/api-reference/rewards/list-rewards"},{"title":"Get reward state summary","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v2/rewards/state_summary","href":"/api-reference/rewards/get-reward-state-summary"},{"title":"Get a reward","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v2/rewards/{reward_id}","href":"/api-reference/rewards/get-a-reward"},{"title":"Update a reward","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json put /v2/rewards/{reward_id}","href":"/api-reference/rewards/update-a-reward"},{"title":"Get reward cancels","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v2/rewards/{reward_id}/cancels","href":"/api-reference/rewards/get-reward-cancels"},{"title":"Get reward expirations","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v2/rewards/{reward_id}/expirations","href":"/api-reference/rewards/get-reward-expirations"},{"title":"Get reward fails","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v2/rewards/{reward_id}/fails","href":"/api-reference/rewards/get-reward-fails"},{"title":"Get reward fulfillments","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v2/rewards/{reward_id}/fulfillments","href":"/api-reference/rewards/get-reward-fulfillments"},{"title":"Get reward state history","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v2/rewards/{reward_id}/history","href":"/api-reference/rewards/get-reward-state-history"},{"title":"Get reward redeems","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v2/rewards/{reward_id}/redeems","href":"/api-reference/rewards/get-reward-redeems"},{"title":"Get reward revokes","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v2/rewards/{reward_id}/revokes","href":"/api-reference/rewards/get-reward-revokes"},{"title":"Get reward sends","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json get /v2/rewards/{reward_id}/sends","href":"/api-reference/rewards/get-reward-sends"},{"title":"Mark custom reward failed","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v2/rewards/custom-reward/{reward_id}/failed","href":"/api-reference/rewards/mark-custom-reward-failed"},{"title":"Mark custom reward fulfilled","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v2/rewards/custom-reward/{reward_id}/fulfilled","href":"/api-reference/rewards/mark-custom-reward-fulfilled"},{"title":"Mark custom reward fulfilled and sent","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v2/rewards/custom-reward/{reward_id}/fulfilled_and_sent","href":"/api-reference/rewards/mark-custom-reward-fulfilled-and-sent"},{"title":"Mark custom reward redeemed","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v2/rewards/custom-reward/{reward_id}/redeemed","href":"/api-reference/rewards/mark-custom-reward-redeemed"},{"title":"Mark custom reward sent","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v2/rewards/custom-reward/{reward_id}/sent","href":"/api-reference/rewards/mark-custom-reward-sent"},{"title":"Cancel a reward","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v2/rewards/{reward_id}/cancel","href":"/api-reference/rewards/cancel-a-reward"},{"title":"Expire a reward","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v2/rewards/{reward_id}/expire","href":"/api-reference/rewards/expire-a-reward"},{"title":"Retry a reward","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v2/rewards/{reward_id}/retry","href":"/api-reference/rewards/retry-a-reward"},{"title":"Revoke a reward","deprecated":null,"version":null,"openapi":"/api-reference/integration-server-to-extole.json post /v2/rewards/{reward_id}/revoke","href":"/api-reference/rewards/revoke-a-reward"}]}]},{"group":"Management API","pages":[{"group":"Audiences","pages":[{"title":"List audiences","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/audiences","href":"/api-reference/audiences/list-audiences"},{"title":"Create audience","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/audiences","href":"/api-reference/audiences/create-audience"},{"title":"List built audiences","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/audiences/built","href":"/api-reference/audiences/list-built-audiences"},{"title":"Get audience","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/audiences/{audience_id}","href":"/api-reference/audiences/get-audience"},{"title":"Update audience","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v1/audiences/{audience_id}","href":"/api-reference/audiences/update-audience"},{"title":"Archive audience","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v1/audiences/{audience_id}","href":"/api-reference/audiences/archive-audience"},{"title":"Get built audience","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/audiences/{audience_id}/built","href":"/api-reference/audiences/get-built-audience"},{"title":"List audience member IDs","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/audiences/{audience_id}/members","href":"/api-reference/audiences/list-audience-member-ids"},{"title":"Download audience members","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/audiences/{audience_id}/members/download{format}","href":"/api-reference/audiences/download-audience-members"},{"title":"List audience members","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/audiences/{audience_id}/members/view/details","href":"/api-reference/audiences/list-audience-members"},{"title":"List audience operations","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/audiences/{audience_id}/operations","href":"/api-reference/audiences/list-audience-operations"},{"title":"Create an audience operation","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/audiences/{audience_id}/operations","href":"/api-reference/audiences/create-an-audience-operation"},{"title":"Get an audience operation","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/audiences/{audience_id}/operations/{operation_id}","href":"/api-reference/audiences/get-an-audience-operation"},{"title":"Get audience operation state","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/audiences/{audience_id}/operations/{operation_id}/state","href":"/api-reference/audiences/get-audience-operation-state"},{"title":"Get audience operation debug state","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/audiences/{audience_id}/operations/{operation_id}/state/debug","href":"/api-reference/audiences/get-audience-operation-debug-state"},{"title":"Get audience operation with details","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/audiences/{audience_id}/operations/{operation_id}/view/details","href":"/api-reference/audiences/get-audience-operation-with-details"},{"title":"Get audience membership statistics","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/audiences/{audience_id}/stats","href":"/api-reference/audiences/get-audience-membership-statistics"},{"title":"Delete audience","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/audiences/{audience_id}/delete","href":"/api-reference/audiences/delete-audience"},{"title":"Cancel an audience operation","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/audiences/{audience_id}/operations/{operation_id}/cancel","href":"/api-reference/audiences/cancel-an-audience-operation"},{"title":"Retry an audience operation","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/audiences/{audience_id}/operations/{operation_id}/retry","href":"/api-reference/audiences/retry-an-audience-operation"},{"title":"Unarchive audience","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/audiences/{audience_id}/unarchive","href":"/api-reference/audiences/unarchive-audience"}]},{"group":"Authentication","pages":[{"title":"Debug consumer access token","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/consumers/{accessToken}/debug","href":"/api-reference/authentication/debug-consumer-access-token"},{"title":"List managed access tokens","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v4/tokens/managed","href":"/api-reference/authentication/list-managed-access-tokens"},{"title":"Create a managed access token","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v4/tokens/managed","href":"/api-reference/authentication/create-a-managed-access-token"},{"title":"Delete a managed access token","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v4/tokens/managed/{access_token_id}","href":"/api-reference/authentication/delete-a-managed-access-token"}]},{"group":"Batch Jobs","pages":[{"title":"List jobs","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/jobs","href":"/api-reference/batch-jobs/list-jobs"},{"title":"Create a job","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/jobs","href":"/api-reference/batch-jobs/create-a-job"},{"title":"List job execution history","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/jobs/history","href":"/api-reference/batch-jobs/list-job-execution-history"},{"title":"Get a job execution history entry","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/jobs/history/{historyId}","href":"/api-reference/batch-jobs/get-a-job-execution-history-entry"},{"title":"Get a job","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/jobs/{jobId}","href":"/api-reference/batch-jobs/get-a-job"},{"title":"Update a job","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v6/jobs/{jobId}","href":"/api-reference/batch-jobs/update-a-job"},{"title":"Delete a job","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v6/jobs/{jobId}","href":"/api-reference/batch-jobs/delete-a-job"},{"title":"Get the built job","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/jobs/{jobId}/built","href":"/api-reference/batch-jobs/get-the-built-job"},{"title":"List tasks","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/jobs/{jobId}/tasks","href":"/api-reference/batch-jobs/list-tasks"},{"title":"Add a task","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/jobs/{jobId}/tasks","href":"/api-reference/batch-jobs/add-a-task"},{"title":"Get a task","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/jobs/{jobId}/tasks/{taskId}","href":"/api-reference/batch-jobs/get-a-task"},{"title":"Update a task","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v6/jobs/{jobId}/tasks/{taskId}","href":"/api-reference/batch-jobs/update-a-task"},{"title":"Delete a task","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v6/jobs/{jobId}/tasks/{taskId}","href":"/api-reference/batch-jobs/delete-a-task"},{"title":"List triggers","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/jobs/{jobId}/triggers","href":"/api-reference/batch-jobs/list-triggers"},{"title":"Add a trigger","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/jobs/{jobId}/triggers","href":"/api-reference/batch-jobs/add-a-trigger"},{"title":"Get a trigger","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/jobs/{jobId}/triggers/{triggerId}","href":"/api-reference/batch-jobs/get-a-trigger"},{"title":"Update a trigger","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v6/jobs/{jobId}/triggers/{triggerId}","href":"/api-reference/batch-jobs/update-a-trigger"},{"title":"Delete a trigger","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v6/jobs/{jobId}/triggers/{triggerId}","href":"/api-reference/batch-jobs/delete-a-trigger"}]},{"group":"Batch Jobs (Legacy)","pages":[{"title":"List batch jobs","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/batches","href":"/api-reference/batch-jobs-legacy/list-batch-jobs"},{"title":"Create a batch job","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/batches","href":"/api-reference/batch-jobs-legacy/create-a-batch-job"},{"title":"Get a batch job","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/batches/{batchId}","href":"/api-reference/batch-jobs-legacy/get-a-batch-job"},{"title":"Update a batch job","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v6/batches/{batchId}","href":"/api-reference/batch-jobs-legacy/update-a-batch-job"},{"title":"Delete a batch job","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v6/batches/{batchId}","href":"/api-reference/batch-jobs-legacy/delete-a-batch-job"},{"title":"Cancel a batch job","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/batches/{batchId}/cancel","href":"/api-reference/batch-jobs-legacy/cancel-a-batch-job"},{"title":"Expire a batch job","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/batches/{batchId}/expire","href":"/api-reference/batch-jobs-legacy/expire-a-batch-job"}]},{"group":"Blocks","pages":[{"title":"List blocks","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/blocks","href":"/api-reference/blocks/list-blocks"},{"title":"Create a block","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/blocks","href":"/api-reference/blocks/create-a-block"},{"title":"List global blocks","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/blocks/global","href":"/api-reference/blocks/list-global-blocks"},{"title":"Get a block","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/blocks/{blockId}","href":"/api-reference/blocks/get-a-block"},{"title":"Delete a block","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v2/blocks/{blockId}","href":"/api-reference/blocks/delete-a-block"},{"title":"Test a block","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/blocks/test","href":"/api-reference/blocks/test-a-block"}]},{"group":"Campaigns","pages":[{"title":"List campaign summaries","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/campaign-summaries","href":"/api-reference/campaigns/list-campaign-summaries"},{"title":"Get a campaign summary","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/campaign-summaries/{campaignId}","href":"/api-reference/campaigns/get-a-campaign-summary"},{"title":"Get a campaign summary by version","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/campaign-summaries/{campaignId}/version/{version}","href":"/api-reference/campaigns/get-a-campaign-summary-by-version"},{"title":"List campaigns","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"Create a campaign","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns","href":"/api-reference/campaigns/create-a-campaign"},{"title":"List built campaigns","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/campaigns/built","href":"/api-reference/campaigns/list-built-campaigns"},{"title":"List deleted campaigns","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/campaigns/deleted","href":"/api-reference/campaigns/list-deleted-campaigns"},{"title":"List duplicatable campaigns","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/campaigns/duplicatable","href":"/api-reference/campaigns/list-duplicatable-campaigns"},{"title":"Get a campaign","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/campaigns/{campaignId}","href":"/api-reference/campaigns/get-a-campaign"},{"title":"Edit a campaign","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v2/campaigns/{campaignId}","href":"/api-reference/campaigns/edit-a-campaign"},{"title":"Delete a campaign","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v2/campaigns/{campaignId}","href":"/api-reference/campaigns/delete-a-campaign"},{"title":"Get a built campaign","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/campaigns/{campaignId}/built","href":"/api-reference/campaigns/get-a-built-campaign"},{"title":"Download a campaign bundle","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/campaigns/{campaignId}.zip","href":"/api-reference/campaigns/download-a-campaign-bundle"},{"title":"Get campaign version history","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/campaigns/{campaignId}/versions","href":"/api-reference/campaigns/get-campaign-version-history"},{"title":"Get a campaign by version","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/campaigns/{campaignId}/version/{version}","href":"/api-reference/campaigns/get-a-campaign-by-version"},{"title":"Get a built campaign by version","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/campaigns/{campaignId}/version/{version}/built","href":"/api-reference/campaigns/get-a-built-campaign-by-version"},{"title":"Download a campaign bundle by version","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/campaigns/{campaignId}/version/{version}.zip","href":"/api-reference/campaigns/download-a-campaign-bundle-by-version"},{"title":"Rename a campaigns program label","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns/program/{programLabel}/rename","href":"/api-reference/campaigns/rename-a-campaigns-program-label"},{"title":"Upload a new campaign from archive","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns/upload-bundle","href":"/api-reference/campaigns/upload-a-new-campaign-from-archive"},{"title":"Archive a campaign","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns/{campaignId}/archive","href":"/api-reference/campaigns/archive-a-campaign"},{"title":"Discard a campaign draft","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns/{campaignId}/discard","href":"/api-reference/campaigns/discard-a-campaign-draft"},{"title":"Duplicate a campaign","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns/{campaignId}/duplicate","href":"/api-reference/campaigns/duplicate-a-campaign"},{"title":"End a campaign","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns/{campaignId}/end","href":"/api-reference/campaigns/end-a-campaign"},{"title":"Launch a campaign in burst mode","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns/{campaignId}/launch-burst","href":"/api-reference/campaigns/launch-a-campaign-in-burst-mode"},{"title":"Launch a campaign in test mode","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns/{campaignId}/launch-test","href":"/api-reference/campaigns/launch-a-campaign-in-test-mode"},{"title":"Set a campaign live","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns/{campaignId}/live","href":"/api-reference/campaigns/set-a-campaign-live"},{"title":"Lock a campaign","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns/{campaignId}/lock","href":"/api-reference/campaigns/lock-a-campaign"},{"title":"Make a campaign the latest draft","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns/{campaignId}/make-latest-draft","href":"/api-reference/campaigns/make-a-campaign-the-latest-draft"},{"title":"Make a campaign latest while preserving state","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns/{campaignId}/make-latest-preserve-state","href":"/api-reference/campaigns/make-a-campaign-latest-while-preserving-state"},{"title":"Make a campaign the latest published","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns/{campaignId}/make-latest-published","href":"/api-reference/campaigns/make-a-campaign-the-latest-published"},{"title":"Pause a campaign","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns/{campaignId}/pause","href":"/api-reference/campaigns/pause-a-campaign"},{"title":"Publish a campaign","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns/{campaignId}/publish","href":"/api-reference/campaigns/publish-a-campaign"},{"title":"Schedule a campaign state change","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns/{campaignId}/schedule","href":"/api-reference/campaigns/schedule-a-campaign-state-change"},{"title":"Stop a campaign","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns/{campaignId}/stop","href":"/api-reference/campaigns/stop-a-campaign"},{"title":"Unarchive a campaign","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns/{campaignId}/unarchive","href":"/api-reference/campaigns/unarchive-a-campaign"},{"title":"Undelete a campaign","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns/{campaignId}/undelete","href":"/api-reference/campaigns/undelete-a-campaign"},{"title":"Unlock a campaign","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/campaigns/{campaignId}/unlock","href":"/api-reference/campaigns/unlock-a-campaign"},{"title":"Update campaigns by program label","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v2/campaigns/program/{program_label}/update","href":"/api-reference/campaigns/update-campaigns-by-program-label"},{"title":"Update a campaign from archive","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v2/campaigns/{campaignId}/upload-bundle","href":"/api-reference/campaigns/update-a-campaign-from-archive"}]},{"group":"Components","pages":[{"title":"List components","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components","href":"/api-reference/components/list-components"},{"title":"Create a component","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/components","href":"/api-reference/components/create-a-component"},{"title":"List built components","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/built","href":"/api-reference/components/list-built-components"},{"title":"List duplicatable components","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/duplicatable","href":"/api-reference/components/list-duplicatable-components"},{"title":"List built duplicatable components","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/duplicatable/built","href":"/api-reference/components/list-built-duplicatable-components"},{"title":"Get a component","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}","href":"/api-reference/components/get-a-component"},{"title":"Update a component","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v1/components/{component_id}","href":"/api-reference/components/update-a-component"},{"title":"Delete a component","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v1/components/{component_id}","href":"/api-reference/components/delete-a-component"},{"title":"Get a built component","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/built","href":"/api-reference/components/get-a-built-component"},{"title":"Get component anchors","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/anchors","href":"/api-reference/components/get-component-anchors"},{"title":"Get available component upgrades","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/available-upgrades","href":"/api-reference/components/get-available-component-upgrades"},{"title":"Diff two components","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/diff/{other_component_id}","href":"/api-reference/components/diff-two-components"},{"title":"List the components that use or could use a component","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/selectable-by-references","href":"/api-reference/components/list-the-components-that-use-or-could-use-a-component"},{"title":"Download translatable component variables","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/translatable.{format}","href":"/api-reference/components/download-translatable-component-variables"},{"title":"List component assets","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/assets","href":"/api-reference/components/list-component-assets"},{"title":"Create a component asset","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/components/{component_id}/assets","href":"/api-reference/components/create-a-component-asset"},{"title":"List built component assets","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/assets/built","href":"/api-reference/components/list-built-component-assets"},{"title":"Get a component asset","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/assets/{asset_id}","href":"/api-reference/components/get-a-component-asset"},{"title":"Update a component asset","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v1/components/{component_id}/assets/{asset_id}","href":"/api-reference/components/update-a-component-asset"},{"title":"Delete a component asset","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v1/components/{component_id}/assets/{asset_id}","href":"/api-reference/components/delete-a-component-asset"},{"title":"Get a built component asset","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/assets/{asset_id}/built","href":"/api-reference/components/get-a-built-component-asset"},{"title":"Get component asset content","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/assets/{asset_id}/content","href":"/api-reference/components/get-component-asset-content"},{"title":"List component settings","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/settings","href":"/api-reference/components/list-component-settings"},{"title":"Create a component setting","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/components/{component_id}/settings","href":"/api-reference/components/create-a-component-setting"},{"title":"Batch update component settings","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v1/components/{component_id}/settings","href":"/api-reference/components/batch-update-component-settings"},{"title":"List built component settings","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/settings/built","href":"/api-reference/components/list-built-component-settings"},{"title":"List selectable components for a component reference list","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/settings/component-reference-list/{setting_name}/selectable-components","href":"/api-reference/components/list-selectable-components-for-a-component-reference-list"},{"title":"List selected components for a component reference list","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/settings/component-reference-list/{setting_name}/selected-components","href":"/api-reference/components/list-selected-components-for-a-component-reference-list"},{"title":"List selectable components for a component reference","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/settings/component-reference/{setting_name}/selectable-components","href":"/api-reference/components/list-selectable-components-for-a-component-reference"},{"title":"List selected components for a component reference","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/settings/component-reference/{setting_name}/selected-components","href":"/api-reference/components/list-selected-components-for-a-component-reference"},{"title":"Get a component setting","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/settings/{setting_name}","href":"/api-reference/components/get-a-component-setting"},{"title":"Update a component setting","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v1/components/{component_id}/settings/{setting_name}","href":"/api-reference/components/update-a-component-setting"},{"title":"Delete a component setting","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v1/components/{component_id}/settings/{setting_name}","href":"/api-reference/components/delete-a-component-setting"},{"title":"Get a built component setting","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/settings/{setting_name}/built","href":"/api-reference/components/get-a-built-component-setting"},{"title":"List installed components in setting","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/settings/{setting_name}/installed-components","href":"/api-reference/components/list-installed-components-in-setting"},{"title":"Get a component by version","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/version/{version}","href":"/api-reference/components/get-a-component-by-version"},{"title":"Get a built component by version","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/version/{version}/built","href":"/api-reference/components/get-a-built-component-by-version"},{"title":"Get component anchors by version","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/version/{version}/anchors","href":"/api-reference/components/get-component-anchors-by-version"},{"title":"Duplicate a component","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/components/{component_id}/duplicate","href":"/api-reference/components/duplicate-a-component"},{"title":"Upgrade a component","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/components/{component_id}/upgrade","href":"/api-reference/components/upgrade-a-component"},{"title":"Add components to a component reference list","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/components/{component_id}/settings/component-reference-list/{setting_name}/add","href":"/api-reference/components/add-components-to-a-component-reference-list"},{"title":"Select components for a component reference list","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/components/{component_id}/settings/component-reference-list/{setting_name}/select","href":"/api-reference/components/select-components-for-a-component-reference-list"},{"title":"Unselect components for a component reference list","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/components/{component_id}/settings/component-reference-list/{setting_name}/unselect","href":"/api-reference/components/unselect-components-for-a-component-reference-list"},{"title":"Select a component for a component reference","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/components/{component_id}/settings/component-reference/{setting_name}/select","href":"/api-reference/components/select-a-component-for-a-component-reference"},{"title":"Unselect a component for a component reference","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/components/{component_id}/settings/component-reference/{setting_name}/unselect","href":"/api-reference/components/unselect-a-component-for-a-component-reference"},{"title":"Add component to setting","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/components/{component_id}/settings/{setting_name}/add-component","href":"/api-reference/components/add-component-to-setting"},{"title":"Remove component from setting","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/components/{component_id}/settings/{setting_name}/remove-component/{target_component_id}","href":"/api-reference/components/remove-component-from-setting"},{"title":"Upload translatable component variables","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v1/components/translatable","href":"/api-reference/components/upload-translatable-component-variables"},{"title":"Connect a component to an origin","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v1/components/{component_id}/origin","href":"/api-reference/components/connect-a-component-to-an-origin"}]},{"group":"Components Operations","pages":[{"title":"List component operations","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/operations","href":"/api-reference/components-operations/list-component-operations"},{"title":"Create a component operation","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/components/{component_id}/operations","href":"/api-reference/components-operations/create-a-component-operation"},{"title":"List built component operations","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/operations/built","href":"/api-reference/components-operations/list-built-component-operations"},{"title":"Get a component operation","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/operations/{operation_name}","href":"/api-reference/components-operations/get-a-component-operation"},{"title":"Update a component operation","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v1/components/{component_id}/operations/{operation_name}","href":"/api-reference/components-operations/update-a-component-operation"},{"title":"Delete a component operation","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v1/components/{component_id}/operations/{operation_name}","href":"/api-reference/components-operations/delete-a-component-operation"},{"title":"Get a built component operation","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/components/{component_id}/operations/{operation_name}/built","href":"/api-reference/components-operations/get-a-built-component-operation"}]},{"group":"Domains","pages":[{"title":"List client domains","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/client-domains","href":"/api-reference/domains/list-client-domains"},{"title":"Create client domain","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/client-domains","href":"/api-reference/domains/create-client-domain"},{"title":"Get client domain","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/client-domains/{client_domain_id}","href":"/api-reference/domains/get-client-domain"},{"title":"Update client domain","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v1/client-domains/{client_domain_id}","href":"/api-reference/domains/update-client-domain"},{"title":"Archive client domain","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v1/client-domains/{client_domain_id}","href":"/api-reference/domains/archive-client-domain"},{"title":"Get client domain with decrypted SSL private key","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v1/client-domains/{client_domain_id}/decrypt","href":"/api-reference/domains/get-client-domain-with-decrypted-ssl-private-key"},{"title":"Validate client domain","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v1/client-domains/{client_domain_id}/validate","href":"/api-reference/domains/validate-client-domain"}]},{"group":"Email","pages":[{"title":"List email domains","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v4/email-domains","href":"/api-reference/email/list-email-domains"},{"title":"Create an email domain","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v4/email-domains","href":"/api-reference/email/create-an-email-domain"},{"title":"Get an email domain","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v4/email-domains/{emailDomainId}","href":"/api-reference/email/get-an-email-domain"},{"title":"Update an email domain","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v4/email-domains/{emailDomainId}","href":"/api-reference/email/update-an-email-domain"},{"title":"Delete an email domain","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v4/email-domains/{emailDomainId}","href":"/api-reference/email/delete-an-email-domain"},{"title":"Validate an email domain","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v4/email-domains/{emailDomainId}/validate","href":"/api-reference/email/validate-an-email-domain"}]},{"group":"Erasure","pages":[{"title":"Create an erasure request","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v4/erasures","href":"/api-reference/erasure/create-an-erasure-request"}]},{"group":"Event Streams","pages":[{"title":"List event streams","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/event-streams","href":"/api-reference/event-streams/list-event-streams"},{"title":"Create an event stream","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/event-streams","href":"/api-reference/event-streams/create-an-event-stream"},{"title":"List built event streams","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/event-streams/built","href":"/api-reference/event-streams/list-built-event-streams"},{"title":"Get an event stream","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/event-streams/{eventStreamId}","href":"/api-reference/event-streams/get-an-event-stream"},{"title":"Update an event stream","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v6/event-streams/{eventStreamId}","href":"/api-reference/event-streams/update-an-event-stream"},{"title":"Archive an event stream","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v6/event-streams/{eventStreamId}","href":"/api-reference/event-streams/archive-an-event-stream"},{"title":"Get a built event stream","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/event-streams/{eventStreamId}/built","href":"/api-reference/event-streams/get-a-built-event-stream"},{"title":"List events from an event stream","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/event-streams/{eventStreamId}/events","href":"/api-reference/event-streams/list-events-from-an-event-stream"},{"title":"List event stream filters","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/event-streams/{eventStreamId}/filters","href":"/api-reference/event-streams/list-event-stream-filters"},{"title":"Create an event stream filter","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/event-streams/{eventStreamId}/filters","href":"/api-reference/event-streams/create-an-event-stream-filter"},{"title":"Get an event stream filter","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/event-streams/{eventStreamId}/filters/{filterId}","href":"/api-reference/event-streams/get-an-event-stream-filter"},{"title":"Update an event stream filter","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v6/event-streams/{eventStreamId}/filters/{filterId}","href":"/api-reference/event-streams/update-an-event-stream-filter"},{"title":"Archive an event stream filter","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v6/event-streams/{eventStreamId}/filters/{filterId}","href":"/api-reference/event-streams/archive-an-event-stream-filter"},{"title":"Delete an event stream","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/event-streams/{eventStreamId}/delete","href":"/api-reference/event-streams/delete-an-event-stream"},{"title":"Unarchive an event stream","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/event-streams/{eventStreamId}/unarchive","href":"/api-reference/event-streams/unarchive-an-event-stream"}]},{"group":"Optout","pages":[{"title":"Get opt-out status","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v4/optouts","href":"/api-reference/optout/get-opt-out-status"}]},{"group":"Profiles","pages":[{"title":"Get a shareable link","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v3/shareables/{code}","href":"/api-reference/profiles/get-a-shareable-link"}]},{"group":"Promotion Links","pages":[{"title":"List promotion links","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/promotion-links","href":"/api-reference/promotion-links/list-promotion-links"},{"title":"Create a promotion link","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/promotion-links","href":"/api-reference/promotion-links/create-a-promotion-link"},{"title":"Get a promotion link","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/promotion-links/{code}","href":"/api-reference/promotion-links/get-a-promotion-link"}]},{"group":"Report Schedules","pages":[{"title":"List report runners","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v7/report-runners","href":"/api-reference/report-schedules/list-report-runners"},{"title":"Create a report runner","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v7/report-runners","href":"/api-reference/report-schedules/create-a-report-runner"},{"title":"List report runner templates","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v7/report-runners/template","href":"/api-reference/report-schedules/list-report-runner-templates"},{"title":"Get a report runner","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v7/report-runners/{reportRunnerId}","href":"/api-reference/report-schedules/get-a-report-runner"},{"title":"Update a report runner","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v7/report-runners/{reportRunnerId}","href":"/api-reference/report-schedules/update-a-report-runner"},{"title":"Delete a report runner","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v7/report-runners/{reportRunnerId}","href":"/api-reference/report-schedules/delete-a-report-runner"},{"title":"Generate missing reports for a schedule","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/report-runners/scheduled/{reportRunnerId}/generate-missing-reports","href":"/api-reference/report-schedules/generate-missing-reports-for-a-schedule"},{"title":"Duplicate a report runner","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v7/report-runners/{reportRunnerId}/duplicate","href":"/api-reference/report-schedules/duplicate-a-report-runner"}]},{"group":"Report Types","pages":[{"title":"List report types","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/report-types","href":"/api-reference/report-types/list-report-types"},{"title":"List report types with their associated clients","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/report-types/clients","href":"/api-reference/report-types/list-report-types-with-their-associated-clients"},{"title":"List recommended report types","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/report-types/recommendations","href":"/api-reference/report-types/list-recommended-report-types"},{"title":"List report type schemas","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/report-types/schemas","href":"/api-reference/report-types/list-report-type-schemas"},{"title":"Get report type","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/report-types/{id}","href":"/api-reference/report-types/get-report-type"},{"title":"Update a report type","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v6/report-types/{id}","href":"/api-reference/report-types/update-a-report-type"},{"title":"Delete a report type","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v6/report-types/{id}","href":"/api-reference/report-types/delete-a-report-type"},{"title":"Get report type mapping suggestions","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/report-types/{id}/mapping-suggestions","href":"/api-reference/report-types/get-report-type-mapping-suggestions"},{"title":"Get report type schema","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/report-types/{id}/schema","href":"/api-reference/report-types/get-report-type-schema"},{"title":"Get report type schema for a context","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/report-types/{id}/schema","href":"/api-reference/report-types/get-report-type-schema-for-a-context"}]},{"group":"Reports","pages":[{"title":"List reports","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v4/reports","href":"/api-reference/reports/list-reports"},{"title":"Create a report","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v4/reports","href":"/api-reference/reports/create-a-report"},{"title":"List report tags","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v4/reports-tags","href":"/api-reference/reports/list-report-tags"},{"title":"Get the latest report","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v4/reports/latest","href":"/api-reference/reports/get-the-latest-report"},{"title":"Download the latest report","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v4/reports/latest/download{format}","href":"/api-reference/reports/download-the-latest-report"},{"title":"List report type performance profiles","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v4/reports/performance-profiles","href":"/api-reference/reports/list-report-type-performance-profiles"},{"title":"Get report type performance profile","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v4/reports/performance-profiles/{report_type}","href":"/api-reference/reports/get-report-type-performance-profile"},{"title":"List report recommendations","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v4/reports/recommendations","href":"/api-reference/reports/list-report-recommendations"},{"title":"Get a report","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v4/reports/{reportId}","href":"/api-reference/reports/get-a-report"},{"title":"Update a report","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v4/reports/{reportId}","href":"/api-reference/reports/update-a-report"},{"title":"Delete a report","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v4/reports/{reportId}","href":"/api-reference/reports/delete-a-report"},{"title":"Get report debug info","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v4/reports/{reportId}/debug","href":"/api-reference/reports/get-report-debug-info"},{"title":"Download a report","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v4/reports/{reportId}/download{format}","href":"/api-reference/reports/download-a-report"},{"title":"Get report info","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v4/reports/{reportId}/info","href":"/api-reference/reports/get-report-info"},{"title":"Get report format info","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v4/reports/{reportId}/info/{format}","href":"/api-reference/reports/get-report-format-info"},{"title":"Get public view of a report","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v4/reports/{reportId}/views/public","href":"/api-reference/reports/get-public-view-of-a-report"},{"title":"Cancel a report","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v4/reports/{reportId}/cancel","href":"/api-reference/reports/cancel-a-report"},{"title":"Retry a report","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v4/reports/{reportId}/retry","href":"/api-reference/reports/retry-a-report"},{"title":"Create a shared token for a report","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v4/reports/{reportId}/sharedToken","href":"/api-reference/reports/create-a-shared-token-for-a-report"}]},{"group":"Reward Suppliers","pages":[{"title":"Download manual coupons","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/reward-suppliers/manual-coupons/{reward_supplier_id}/coupons","href":"/api-reference/reward-suppliers/download-manual-coupons"},{"title":"Upload manual coupons file","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/reward-suppliers/manual-coupons/{reward_supplier_id}/coupons","href":"/api-reference/reward-suppliers/upload-manual-coupons-file"},{"title":"Delete manual coupons","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v2/reward-suppliers/manual-coupons/{reward_supplier_id}/coupons","href":"/api-reference/reward-suppliers/delete-manual-coupons"},{"title":"Download manual coupons file","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/reward-suppliers/manual-coupons/{reward_supplier_id}/coupons{extension}","href":"/api-reference/reward-suppliers/download-manual-coupons-file"},{"title":"Get manual coupon operations","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/reward-suppliers/manual-coupons/{reward_supplier_id}/operations","href":"/api-reference/reward-suppliers/get-manual-coupon-operations"},{"title":"Get manual coupon stats","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/reward-suppliers/manual-coupons/{reward_supplier_id}/stats","href":"/api-reference/reward-suppliers/get-manual-coupon-stats"},{"title":"List Salesforce coupon pools","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/reward-suppliers/salesforce-coupons/list-available-coupon-pools","href":"/api-reference/reward-suppliers/list-salesforce-coupon-pools"},{"title":"Get Salesforce coupon operations","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/reward-suppliers/salesforce-coupons/{reward_supplier_id}/operations","href":"/api-reference/reward-suppliers/get-salesforce-coupon-operations"},{"title":"Get Salesforce coupon stats","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/reward-suppliers/salesforce-coupons/{reward_supplier_id}/stats","href":"/api-reference/reward-suppliers/get-salesforce-coupon-stats"},{"title":"Get Tango catalog","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/reward-suppliers/tango/catalog","href":"/api-reference/reward-suppliers/get-tango-catalog"},{"title":"List reward suppliers","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/reward-suppliers","href":"/api-reference/reward-suppliers/list-reward-suppliers"},{"title":"Create a reward supplier","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/reward-suppliers","href":"/api-reference/reward-suppliers/create-a-reward-supplier"},{"title":"List built reward suppliers","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/reward-suppliers/built","href":"/api-reference/reward-suppliers/list-built-reward-suppliers"},{"title":"Get reward supplier display types","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/reward-suppliers/display-types","href":"/api-reference/reward-suppliers/get-reward-supplier-display-types"},{"title":"Get a reward supplier","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/reward-suppliers/{reward_supplier_id}","href":"/api-reference/reward-suppliers/get-a-reward-supplier"},{"title":"Update a reward supplier","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v6/reward-suppliers/{reward_supplier_id}","href":"/api-reference/reward-suppliers/update-a-reward-supplier"},{"title":"Archive a reward supplier","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v6/reward-suppliers/{reward_supplier_id}","href":"/api-reference/reward-suppliers/archive-a-reward-supplier"},{"title":"Get a built reward supplier","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/reward-suppliers/{reward_supplier_id}/built","href":"/api-reference/reward-suppliers/get-a-built-reward-supplier"},{"title":"Refill Salesforce coupons","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/reward-suppliers/salesforce-coupons/{reward_supplier_id}/coupons","href":"/api-reference/reward-suppliers/refill-salesforce-coupons"},{"title":"Delete Salesforce coupons","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v2/reward-suppliers/salesforce-coupons/{reward_supplier_id}/coupons","href":"/api-reference/reward-suppliers/delete-salesforce-coupons"},{"title":"Unarchive a reward supplier","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/reward-suppliers/{reward_supplier_id}/unarchive","href":"/api-reference/reward-suppliers/unarchive-a-reward-supplier"},{"title":"Delete a reward supplier","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v6/reward-suppliers/{reward_supplier_id}/delete","href":"/api-reference/reward-suppliers/delete-a-reward-supplier"}]},{"group":"SFTP Servers","pages":[{"title":"List SFTP destinations","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/sftp-destinations","href":"/api-reference/sftp-servers/list-sftp-destinations"},{"title":"Create an SFTP destination","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/sftp-destinations","href":"/api-reference/sftp-servers/create-an-sftp-destination"},{"title":"Get an SFTP destination","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/sftp-destinations/{sftpDestinationId}","href":"/api-reference/sftp-servers/get-an-sftp-destination"},{"title":"Update an SFTP destination","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v6/sftp-destinations/{sftpDestinationId}","href":"/api-reference/sftp-servers/update-an-sftp-destination"},{"title":"Delete an SFTP destination","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v6/sftp-destinations/{sftpDestinationId}","href":"/api-reference/sftp-servers/delete-an-sftp-destination"},{"title":"List SFTP destination directory entries","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/sftp-destinations/{sftpDestinationId}/entries","href":"/api-reference/sftp-servers/list-sftp-destination-directory-entries"},{"title":"Sync an SFTP destination","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/sftp-destinations/{sftpDestinationId}/sync","href":"/api-reference/sftp-servers/sync-an-sftp-destination"},{"title":"Validate an SFTP destination","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/sftp-destinations/{sftpDestinationId}/validate","href":"/api-reference/sftp-servers/validate-an-sftp-destination"}]},{"group":"Security Keys","pages":[{"title":"List client keys","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/settings/security/keys","href":"/api-reference/security-keys/list-client-keys"},{"title":"Create client key","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/settings/security/keys","href":"/api-reference/security-keys/create-client-key"},{"title":"List built client keys","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/settings/security/keys/built","href":"/api-reference/security-keys/list-built-client-keys"},{"title":"Create client key from file","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/settings/security/keys/upload","href":"/api-reference/security-keys/create-client-key-from-file"},{"title":"Delete client key","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/settings/security/keys/{key_id}/delete","href":"/api-reference/security-keys/delete-client-key"},{"title":"Unarchive client key","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/settings/security/keys/{key_id}/unarchive","href":"/api-reference/security-keys/unarchive-client-key"},{"title":"Update client key","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v2/settings/security/keys/{key_id}","href":"/api-reference/security-keys/update-client-key"},{"title":"Archive client key","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v2/settings/security/keys/{key_id}","href":"/api-reference/security-keys/archive-client-key"}]},{"group":"Settings","pages":[{"title":"Get the client logo","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/logo","href":"/api-reference/settings/get-the-client-logo"},{"title":"Upload a client logo","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/logo","href":"/api-reference/settings/upload-a-client-logo"},{"title":"Archive the client logo","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v2/logo","href":"/api-reference/settings/archive-the-client-logo"},{"title":"Download logo image","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/logo/image","href":"/api-reference/settings/download-logo-image"},{"title":"List timeline entries","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/timeline-entries","href":"/api-reference/settings/list-timeline-entries"},{"title":"Create a timeline entry","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/timeline-entries","href":"/api-reference/settings/create-a-timeline-entry"},{"title":"Get a timeline entry","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/timeline-entries/{name}","href":"/api-reference/settings/get-a-timeline-entry"},{"title":"Update a timeline entry","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v2/timeline-entries/{name}","href":"/api-reference/settings/update-a-timeline-entry"},{"title":"Delete a timeline entry","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v2/timeline-entries/{name}","href":"/api-reference/settings/delete-a-timeline-entry"}]},{"group":"User Notifications","pages":[{"title":"List recent notifications","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/notifications","href":"/api-reference/user-notifications/list-recent-notifications"},{"title":"Get notification read cursor","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/notifications/read","href":"/api-reference/user-notifications/get-notification-read-cursor"},{"title":"Mark notifications as read","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/notifications/read","href":"/api-reference/user-notifications/mark-notifications-as-read"},{"title":"List notification snoozes for the caller","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/notifications/snoozes","href":"/api-reference/user-notifications/list-notification-snoozes-for-the-caller"},{"title":"Create a notification snooze for the caller","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/notifications/snoozes","href":"/api-reference/user-notifications/create-a-notification-snooze-for-the-caller"},{"title":"Get a notification snooze for the caller","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/notifications/snoozes/{snoozeId}","href":"/api-reference/user-notifications/get-a-notification-snooze-for-the-caller"},{"title":"Delete a notification snooze for the caller","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v6/notifications/snoozes/{snoozeId}","href":"/api-reference/user-notifications/delete-a-notification-snooze-for-the-caller"},{"title":"List notifications for a user","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/notifications/{userId}","href":"/api-reference/user-notifications/list-notifications-for-a-user"},{"title":"Get notification read cursor for a user","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/notifications/{userId}/read","href":"/api-reference/user-notifications/get-notification-read-cursor-for-a-user"},{"title":"Mark notifications as read for a user","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/notifications/{userId}/read","href":"/api-reference/user-notifications/mark-notifications-as-read-for-a-user"},{"title":"List notification snoozes for a user","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/notifications/{userId}/snoozes","href":"/api-reference/user-notifications/list-notification-snoozes-for-a-user"},{"title":"Create a notification snooze for a user","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/notifications/{userId}/snoozes","href":"/api-reference/user-notifications/create-a-notification-snooze-for-a-user"},{"title":"Get a notification snooze for a user","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/notifications/{userId}/snoozes/{snoozeId}","href":"/api-reference/user-notifications/get-a-notification-snooze-for-a-user"},{"title":"Delete a notification snooze for a user","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v6/notifications/{userId}/snoozes/{snoozeId}","href":"/api-reference/user-notifications/delete-a-notification-snooze-for-a-user"}]},{"group":"User Subscriptions","pages":[{"title":"List subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/subscriptions","href":"/api-reference/user-subscriptions/list-subscriptions"},{"title":"List user subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/users/{user_id}/subscriptions","href":"/api-reference/user-subscriptions/list-user-subscriptions"},{"title":"Create a user subscription","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/users/{user_id}/subscriptions","href":"/api-reference/user-subscriptions/create-a-user-subscription"},{"title":"Get a user subscription","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/users/{user_id}/subscriptions/{subscription_id}","href":"/api-reference/user-subscriptions/get-a-user-subscription"},{"title":"Update a user subscription","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v6/users/{user_id}/subscriptions/{subscription_id}","href":"/api-reference/user-subscriptions/update-a-user-subscription"},{"title":"Delete a user subscription","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v6/users/{user_id}/subscriptions/{subscription_id}","href":"/api-reference/user-subscriptions/delete-a-user-subscription"}]},{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/users","href":"/api-reference/users/list-users"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/users","href":"/api-reference/users/create-a-user"},{"title":"Get a user","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/users/{userId}","href":"/api-reference/users/get-a-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v2/users/{userId}","href":"/api-reference/users/update-a-user"},{"title":"Delete a user","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v2/users/{userId}","href":"/api-reference/users/delete-a-user"},{"title":"List user properties","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/users/{user_id}/properties","href":"/api-reference/users/list-user-properties"},{"title":"Create a user property","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/users/{user_id}/properties","href":"/api-reference/users/create-a-user-property"},{"title":"Get a user property","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v2/users/{user_id}/properties/{name}","href":"/api-reference/users/get-a-user-property"},{"title":"Update a user property","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v2/users/{user_id}/properties/{name}","href":"/api-reference/users/update-a-user-property"},{"title":"Delete a user property","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v2/users/{user_id}/properties/{name}","href":"/api-reference/users/delete-a-user-property"},{"title":"Reset user password","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/users/password-reset","href":"/api-reference/users/reset-user-password"},{"title":"Resend user invite email","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/users/resend-invite-email","href":"/api-reference/users/resend-user-invite-email"},{"title":"Unlock a user","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v2/users/{userId}/unlock","href":"/api-reference/users/unlock-a-user"},{"title":"Update user password","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v2/users/update-password","href":"/api-reference/users/update-user-password"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Create a webhook","deprecated":null,"version":null,"openapi":"/api-reference/management.json post /v6/webhooks","href":"/api-reference/webhooks/create-a-webhook"},{"title":"List built webhooks","description":"Returns all webhooks in their fully evaluated (built) runtime form, with all evaluatable fields resolved. Supports finer filtering than the source list: `name`, `include_archived`, `limit`, and `offset` are only available on this endpoint. Use this when you need effective endpoint URLs and headers.","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/webhooks/built","href":"/api-reference/webhooks/list-built-webhooks"},{"title":"Get a webhook","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/webhooks/{webhook_id}","href":"/api-reference/webhooks/get-a-webhook"},{"title":"Update a webhook","description":"Applies a partial update to the supplied webhook. Only the fields present in the body are changed; omitted fields are left intact. Returns the persisted webhook after the update. Returns `400 webhook_not_found` if the id does not exist.","deprecated":null,"version":null,"openapi":"/api-reference/management.json put /v6/webhooks/{webhook_id}","href":"/api-reference/webhooks/update-a-webhook"},{"title":"Archive a webhook","deprecated":null,"version":null,"openapi":"/api-reference/management.json delete /v6/webhooks/{webhook_id}","href":"/api-reference/webhooks/archive-a-webhook"},{"title":"Get a built webhook","deprecated":null,"version":null,"openapi":"/api-reference/management.json get /v6/webhooks/{webhook_id}/built","href":"/api-reference/webhooks/get-a-built-webhook"}]}]},{"group":"Feature Specific APIs","tag":"BETA","pages":[{"group":"Business Events","pages":[{"group":"Tracked Business Event","pages":[{"title":"Create New","deprecated":null,"version":null,"openapi":"/feature-specific-apis/business-events.json post /v6/events/template_tracked_business_event","href":"/api-reference/feature-specific/tracked-business-event/action/create-new"}]},{"group":"Transacted Business Event","pages":[{"title":"Create New","deprecated":null,"version":null,"openapi":"/feature-specific-apis/transactions.json post /v6/events/template_transacted_business_event","href":"/api-reference/feature-specific/transacted-business-event/action/create-new"}]}]},{"group":"Server Events","pages":[{"group":"API Event","pages":[{"title":"Send Event","deprecated":null,"version":null,"openapi":"/feature-specific-apis/trigger-event-api.json post /v6/events/{event_name}","href":"/api-reference/feature-specific/api-event/send-event"}]},{"group":"Delayed Job Event","pages":[{"title":"Send Event","deprecated":null,"version":null,"openapi":"/feature-specific-apis/trigger-event-delay.json post /v6/events/{event_name}","href":"/api-reference/feature-specific/delayed-job-event/send-event"}]},{"group":"Job Event","pages":[{"title":"Send Event","deprecated":null,"version":null,"openapi":"/feature-specific-apis/trigger-event-job.json post /v6/events/{event_name}","href":"/api-reference/feature-specific/job-event/send-event"}]}]},{"group":"Consumer Events","pages":[{"group":"SDK Zone Event","pages":[{"title":"Send Event From Site or App","deprecated":null,"version":null,"openapi":"/feature-specific-apis/trigger-event-sdk-zone.json post /events","href":"/api-reference/feature-specific/sdk-zone-event/send-event-from-site-or-app"}]},{"group":"Zone Event","pages":[{"title":"Send Event From Site or App","deprecated":null,"version":null,"openapi":"/feature-specific-apis/trigger-event-zone.json post /events","href":"/api-reference/feature-specific/zone-event/send-event-from-site-or-app"}]},{"group":"Tagless CTA","pages":[{"title":"Send Event From Site or App","deprecated":null,"version":null,"openapi":"/feature-specific-apis/trigger-event-tagless-cta.json post /events","href":"/api-reference/feature-specific/tagless-cta/send-event-from-site-or-app"}]}]},{"group":"Content","pages":[{"group":"Call To Action","pages":[{"title":"Render","deprecated":null,"version":null,"openapi":"/feature-specific-apis/call-to-action.json get /zones/call_to_action","href":"/api-reference/feature-specific/call-to-action/view/render"},{"title":"Render With Data","deprecated":null,"version":null,"openapi":"/feature-specific-apis/call-to-action.json post /zones/call_to_action","href":"/api-reference/feature-specific/call-to-action/view/render-with-data"},{"title":"Preview Draft","deprecated":null,"version":null,"openapi":"/feature-specific-apis/call-to-action.json get /v5/zones/call_to_action","href":"/api-reference/feature-specific/call-to-action/view/preview-draft"}]},{"group":"Experience","pages":[{"title":"Render","deprecated":null,"version":null,"openapi":"/feature-specific-apis/experience.json get /zones/embedded_experience","href":"/api-reference/feature-specific/experience/view/render"},{"title":"Render With Data","deprecated":null,"version":null,"openapi":"/feature-specific-apis/experience.json post /zones/embedded_experience","href":"/api-reference/feature-specific/experience/view/render-with-data"},{"title":"Preview Draft","deprecated":null,"version":null,"openapi":"/feature-specific-apis/experience.json get /v5/zones/embedded_experience","href":"/api-reference/feature-specific/experience/view/preview-draft"}]},{"group":"Page Creative","pages":[{"title":"Render","deprecated":null,"version":null,"openapi":"/feature-specific-apis/page-creative.json get /zones/template_single_column_page","href":"/api-reference/feature-specific/page-creative/view/render"},{"title":"Render With Data","deprecated":null,"version":null,"openapi":"/feature-specific-apis/page-creative.json post /zones/template_single_column_page","href":"/api-reference/feature-specific/page-creative/view/render-with-data"},{"title":"Preview Draft","deprecated":null,"version":null,"openapi":"/feature-specific-apis/page-creative.json get /v5/zones/template_single_column_page","href":"/api-reference/feature-specific/page-creative/view/preview-draft"}]},{"group":"Promotion Email","pages":[{"title":"Send Now","deprecated":null,"version":null,"openapi":"/feature-specific-apis/promotion-email.json post /v6/events/{event_name}","href":"/api-reference/feature-specific/promotion-email/action/send-now"},{"title":"Send Async","deprecated":null,"version":null,"openapi":"/feature-specific-apis/promotion-email.json post /v6/async-events/{event_name}","href":"/api-reference/feature-specific/promotion-email/action/send-async"}]}]},{"group":"Rewards","pages":[{"group":"Reward Bank","pages":[{"title":"Current Balance and Transaction History","deprecated":null,"version":null,"openapi":"/feature-specific-apis/reward-bank.json post /api/v6/zones/bankable_rewards","href":"/api-reference/feature-specific/reward-bank/view/current-balance-and-transaction-history"},{"title":"Redeem Credits","deprecated":null,"version":null,"openapi":"/feature-specific-apis/reward-bank.json post /events","href":"/api-reference/feature-specific/reward-bank/action/redeem-credits"}]},{"group":"Rewardable","pages":[{"title":"Force Approve","deprecated":null,"version":null,"openapi":"/feature-specific-apis/rewardable.json post /v6/events/{approve_event_name}","href":"/api-reference/feature-specific/rewardable/action/force-approve"},{"title":"Create New","deprecated":null,"version":null,"openapi":"/feature-specific-apis/rewardable.json post /v6/events/{manual_request_event_name}","href":"/api-reference/feature-specific/rewardable/action/create-new"},{"title":"Decline","deprecated":null,"version":null,"openapi":"/feature-specific-apis/rewardable.json post /v6/events/{decline_event_name}","href":"/api-reference/feature-specific/rewardable/action/decline"},{"title":"Re-Evaluate","deprecated":null,"version":null,"openapi":"/feature-specific-apis/rewardable.json post /v6/events/{re_evaluation_event_name}","href":"/api-reference/feature-specific/rewardable/action/re-evaluate"}]}]}]}]},{"tab":"News","pages":[{"title":"News","href":"/news/recent-releases"}]}]},"basePath":"","title":"Get a webhook - Extole Documentation","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}