Webhook triggers allow you to programmatically initiate test runs. This is
most commonly used for CI/CD.To create a webhook trigger, go to the
settings page. You’ll be provided an HTTP
endpoint to hit. For example, to trigger a run on every update to your
staging environment, make a call to the provided URL call on staging
instance startup.
For help configuring the webhook trigger correctly, feel free to reach out
to the team.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Dime","colors":{"primary":"#2b4481","light":"#5b95d9","dark":"#2b4481"},"favicon":"/favicon.png","logo":{"light":"https://mintcdn.com/dime/KX4FlvAWocmFIekI/logo/light.svg?fit=max\u0026auto=format\u0026n=KX4FlvAWocmFIekI\u0026q=85\u0026s=96d1f47805fa5e763078aa442ec25e62","dark":"https://mintcdn.com/dime/KX4FlvAWocmFIekI/logo/dark.svg?fit=max\u0026auto=format\u0026n=KX4FlvAWocmFIekI\u0026q=85\u0026s=bf61808e87b90cb5e1d55f0492255308"},"background":{"decoration":"windows"},"navbar":{"links":[{"label":"Contact us","href":"mailto:founders@dime.io"}],"primary":{"type":"button","label":"Book a call","href":"https://calendly.com/aaron-dime/intro"}},"footer":{"socials":{"website":"https://dime.io","linkedin":"https://www.linkedin.com/company/dime-autotest"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"dime","hasAudioNarration":false,"actualSubdomain":"dime","customDomains":[],"gitSource":{"type":"github","owner":"a-b-testing","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae922055a187fc783f5590f:success","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"Building tests","count":6},{"language":"default","tag":"Test runs","count":4},{"language":"default","tag":"Advanced","count":3},{"language":"default","tag":"Using the builder","count":3},{"language":"default","tag":"Get started","count":2},{"language":"default","tag":"Settings","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"runs/webhooks","slug":"/runs/webhooks","pageMetadata":{"title":"Webhook triggers","description":"Trigger runs programmatically","icon":"plug","href":"/runs/webhooks"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Trigger runs programmatically\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Frame,OptimizedImage}=_components;if(!Frame)_missingMdxReference(`Frame`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Webhook triggers allow you to programmatically initiate test runs. This is\nmost commonly used for CI/CD.`}),`\n`,_jsxs(_components.p,{children:[`To create a webhook trigger, go to the\n`,_jsx(_components.a,{href:`https://dime.io/settings`,children:`settings page`}),`. You’ll be provided an HTTP\nendpoint to hit. For example, to trigger a run on every update to your\nstaging environment, make a call to the provided URL call on staging\ninstance startup.`]}),`\n`,_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://firebasestorage.googleapis.com/v0/b/dime-ac49e.appspot.com/o/docs%2Fwebhook.png?alt=media`})}),`\n`,_jsx(`br`,{}),`\n`,_jsx(_components.p,{children:`For help configuring the webhook trigger correctly, feel free to reach out\nto the team.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Webhook triggers","description":"Trigger runs programmatically","icon":"plug","href":"/runs/webhooks"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"dime","siteName":"Dime","title":"Webhook triggers - Dime","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T03:55:58.650Z","originalFileLocation":"runs/webhooks.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=\"Trigger runs programmatically\">\u003cmeta data-mint-head name=\"application-name\" content=\"Dime\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dime/cPoCDe5am438_YF3/_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/dime/cPoCDe5am438_YF3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dime/cPoCDe5am438_YF3/_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/dime/cPoCDe5am438_YF3/_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/dime/cPoCDe5am438_YF3/_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/dime/cPoCDe5am438_YF3/_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/dime/cPoCDe5am438_YF3/_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/dime/cPoCDe5am438_YF3/_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/dime/cPoCDe5am438_YF3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Webhook triggers - Dime\">\u003cmeta data-mint-head property=\"og:description\" content=\"Trigger runs programmatically\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Dime\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://dime.mintlify.app/runs/webhooks\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://dime.mintlify.site/_mintlify/api/og/v2?division=Test+runs\u0026amp;title=Webhook+triggers\u0026amp;description=Trigger+runs+programmatically\u0026amp;theme=72380d68a59eeeb2545344ed\u0026amp;signature=125e55d9d15afd17875540c51a047a59f0f8ab4cb6d768e9e3645d936b3cf534\">\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=\"Webhook triggers - Dime\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Trigger runs programmatically\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dime.mintlify.site/_mintlify/api/og/v2?division=Test+runs\u0026amp;title=Webhook+triggers\u0026amp;description=Trigger+runs+programmatically\u0026amp;theme=72380d68a59eeeb2545344ed\u0026amp;signature=125e55d9d15afd17875540c51a047a59f0f8ab4cb6d768e9e3645d936b3cf534\">\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/dime/cPoCDe5am438_YF3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Dime\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2b4481\">\u003clink data-mint-head rel=\"canonical\" href=\"https://dime.mintlify.app/runs/webhooks\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/runs/webhooks.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://dime.mintlify.app/#organization\",\"name\":\"Dime\",\"url\":\"https://dime.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/dime/KX4FlvAWocmFIekI/logo/light.svg?fit=max\u0026auto=format\u0026n=KX4FlvAWocmFIekI\u0026q=85\u0026s=96d1f47805fa5e763078aa442ec25e62\"}},{\"@type\":\"WebSite\",\"@id\":\"https://dime.mintlify.app#website\",\"name\":\"Dime\",\"url\":\"https://dime.mintlify.app\",\"publisher\":{\"@id\":\"https://dime.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://dime.mintlify.app/runs/webhooks#webpage\",\"url\":\"https://dime.mintlify.app/runs/webhooks\",\"name\":\"Webhook triggers\",\"description\":\"Trigger runs programmatically\",\"dateModified\":\"2026-01-07T03:55:58.650Z\",\"isPartOf\":{\"@id\":\"https://dime.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://dime.mintlify.app/runs/webhooks#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://dime.mintlify.app/runs/webhooks#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Test runs\",\"item\":\"https://dime.mintlify.app/runs/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Webhook triggers\",\"item\":\"https://dime.mintlify.app/runs/webhooks\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://dime.mintlify.app/runs/webhooks#article\",\"headline\":\"Webhook triggers\",\"name\":\"Webhook triggers\",\"description\":\"Trigger runs programmatically\",\"url\":\"https://dime.mintlify.app/runs/webhooks\",\"mainEntityOfPage\":{\"@id\":\"https://dime.mintlify.app/runs/webhooks#webpage\"},\"dateModified\":\"2026-01-07T03:55:58.650Z\",\"publisher\":{\"@id\":\"https://dime.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://dime.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Dime\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Dime\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/runs/webhooks.md","siteName":"Dime","nav":{"global":null,"groups":[{"group":"Get started","pages":[{"title":"Overview","icon":"globe","href":"/get-started/overview"},{"title":"Quickstart","icon":"rocket","href":"/get-started/quickstart"}]},{"group":"Building tests","pages":[{"title":"Adding tests","icon":"plus","href":"/building/adding"},{"group":"Using the builder","icon":"screwdriver-wrench","pages":[{"title":"Page actions","href":"/building/builder/actions"},{"title":"Navigation","href":"/building/builder/navigation"},{"title":"Custom checks","href":"/building/builder/checks"}]},{"title":"Reusing tests","icon":"recycle","href":"/building/reuse"},{"title":"Editing tests","icon":"pen-to-square","href":"/building/editing"}]},{"group":"Test runs","pages":[{"title":"Starting runs","icon":"play","href":"/runs/overview"},{"title":"Cron triggers","description":"Trigger runs on a regular interval","icon":"clock","href":"/runs/cron"},{"title":"Webhook triggers","icon":"plug","href":"/runs/webhooks"},{"title":"Alerts","description":"Get automatically notified on test failure","icon":"triangle-exclamation","href":"/runs/alerts"}]},{"group":"Settings","pages":[{"title":"Account","icon":"gear","href":"/settings/account"}]},{"group":"Advanced","pages":[{"title":"Profiles","icon":"user","href":"/advanced/profiles"},{"title":"Fragments","icon":"link-simple","href":"/advanced/fragments"},{"title":"Network","icon":"wifi","href":"/advanced/network"}]}]},"basePath":"","title":"Webhook triggers - Dime","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-BXrZabKK.js","DynamicMarkdown-CtasenyM.js","zoom-image-lightbox-C5F0mVLH.js","lightbox-handle-r17bVUz3.js"]}