A guide to using webhooks for real-time notifications and integrations
Webhooks are a way for an application to provide real-time notifications to other systems when certain events occur. They allow you to build integrations that respond to specific events in a more efficient and scalable way than constantly polling an API for updates.In this guide, we’ll explore how to set up and implement webhooks, including establishing a webhook endpoint, configuring your webhooks, and handling webhook notifications.
Use cases
Webhooks can be utilized for various purposes, such as:
Automatically creating a new employee record in your HRIS system when an application is hired.
Updating the jobs on your website when a job is published.
Send a contract offer to the candidate when they are moved to a specified stage.
Webhook payload format
The request body of the webhook will contain 3 properties.
The type of the event, eg. job.created.
The timestamp the event occurred at.
The data property which will contain the object of the event.
You must have the required permission to manage webhooks.
You can create an unlmited number of webhooks. A webhook can listen for a single or multiple events depending on your use case.
You can enable/disable a webhook at anytime and view a log of requests sent to the webhook.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Starter Kit","colors":{"primary":"#1d4ed8","light":"#AE87FF","dark":"#0D001D"},"favicon":"/favicon.svg","logo":{"light":"https://mintcdn.com/hirehive/EwYKqLOxXCdMHqRI/logo/light.svg?fit=max\u0026auto=format\u0026n=EwYKqLOxXCdMHqRI\u0026q=85\u0026s=c51ca959c2189bc80849d307962fee76","dark":"https://mintcdn.com/hirehive/EwYKqLOxXCdMHqRI/logo/dark.svg?fit=max\u0026auto=format\u0026n=EwYKqLOxXCdMHqRI\u0026q=85\u0026s=069a0a5702315c2cc8a214a707f9b757","href":"https://docs.hirehive.com"},"api":{"openapi":["openapi.json","jobs-openapi.json"],"playground":{"display":"interactive"}},"background":{"decoration":null,"color":{"light":null,"dark":"#0e171d"}},"navbar":{"links":[{"label":"Support","href":"mailto:support@hirehive.com"}],"primary":{"type":"button","label":"HireHive Dashboard","href":"https://app.hirehive.com"}},"footer":{"socials":{"twitter":"https://twitter.com/hirehive","github":"https://github.com/hirehive","linkedin":"https://www.linkedin.com/company/hirehive-io"}},"integrations":{"plausible":{"domain":"docs.hirehive.com"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hirehive","hasAudioNarration":false,"actualSubdomain":"hirehive","customDomains":["docs.hirehive.com"],"gitSource":{"type":"github","owner":"hirehive","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{},"buildId":"6ae91a872bff7601755ece8b:success","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"Documentation","count":118},{"language":"default","tag":"API Reference","count":110},{"language":"default","tag":"Endpoints","count":84},{"language":"default","tag":"Settings","count":33},{"language":"default","tag":"Webhooks","count":27},{"language":"default","tag":"Events","count":19},{"language":"default","tag":"Jobs","count":12},{"language":"default","tag":"Candidates","count":10},{"language":"default","tag":"Application and Feedback forms","count":8},{"language":"default","tag":"Applications","count":7}]},"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":"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":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/webhooks/introduction","slug":"/api-reference/webhooks/introduction","pageMetadata":{"title":"Overview","description":"A guide to using webhooks for real-time notifications and integrations","icon":"circle-info","href":"/api-reference/webhooks/introduction"},"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: \"A guide to using webhooks for real-time notifications and integrations\"\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={code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Frame,Heading,Note}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Webhooks are a way for an application to provide real-time notifications to other systems when certain events occur. They allow you to build integrations that respond to specific events in a more efficient and scalable way than constantly polling an API for updates.`}),`\n`,_jsx(_components.p,{children:`In this guide, we’ll explore how to set up and implement webhooks, including establishing a webhook endpoint, configuring your webhooks, and handling webhook notifications.`}),`\n`,_jsx(Heading,{level:`2`,id:`use-cases`,children:`Use cases`}),`\n`,_jsx(_components.p,{children:`Webhooks can be utilized for various purposes, such as:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Automatically creating a new employee record in your HRIS system when an application is hired.`}),`\n`,_jsx(_components.li,{children:`Updating the jobs on your website when a job is published.`}),`\n`,_jsx(_components.li,{children:`Send a contract offer to the candidate when they are moved to a specified stage.`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`webhook-payload-format`,children:`Webhook payload format`}),`\n`,_jsx(_components.p,{children:`The request body of the webhook will contain 3 properties.`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`The `,_jsx(_components.code,{children:`type`}),` of the event, eg. `,_jsx(_components.code,{children:`job.created`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`The `,_jsx(_components.code,{children:`timestamp`}),` the event occurred at.`]}),`\n`,_jsxs(_components.li,{children:[`The `,_jsx(_components.code,{children:`data`}),` property which will contain the object of the event.`]}),`\n`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`7`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"application.created\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"timestamp\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2024-01-24T14:59:34.5220878Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:` ....`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`creating-a-webhook`,children:`Creating a webhook`}),`\n`,_jsx(Note,{children:`You must have the required permission to manage webhooks.`}),`\n`,_jsx(_components.p,{children:`You can create an unlmited number of webhooks. A webhook can listen for a single or multiple events depending on your use case.\nYou can enable/disable a webhook at anytime and view a log of requests sent to the webhook.`}),`\n`,_jsx(Frame,{children:_jsx(`video`,{controls:true,className:`mint-w-full mint-aspect-video`,src:`https://r2.docs.hirehive.com/creating-a-webhook.mp4`})})]})}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":"Overview","description":"A guide to using webhooks for real-time notifications and integrations","icon":"circle-info","href":"/api-reference/webhooks/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Use cases","slug":"use-cases","depth":2,"children":[]},{"title":"Webhook payload format","slug":"webhook-payload-format","depth":2,"children":[]},{"title":"Creating a webhook","slug":"creating-a-webhook","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"dynamicCss":".mint-aspect-video {\n aspect-ratio: 16 / 9\n}\n.mint-w-full {\n width: 100%\n}","subdomain":"hirehive","siteName":"Starter Kit","title":"Overview - Starter Kit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-11-06T14:41:37.182Z","originalFileLocation":"api-reference/webhooks/introduction.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=\"A guide to using webhooks for real-time notifications and integrations\">\u003cmeta data-mint-head name=\"application-name\" content=\"Starter Kit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hirehive/8CvQvXCUMBAiaJJ7/_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/hirehive/8CvQvXCUMBAiaJJ7/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hirehive/8CvQvXCUMBAiaJJ7/_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/hirehive/8CvQvXCUMBAiaJJ7/_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/hirehive/8CvQvXCUMBAiaJJ7/_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/hirehive/8CvQvXCUMBAiaJJ7/_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/hirehive/8CvQvXCUMBAiaJJ7/_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/hirehive/8CvQvXCUMBAiaJJ7/_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/hirehive/8CvQvXCUMBAiaJJ7/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Overview - Starter Kit\">\u003cmeta data-mint-head property=\"og:description\" content=\"A guide to using webhooks for real-time notifications and integrations\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Starter Kit\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hirehive.com/api-reference/webhooks/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hirehive.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Overview\u0026amp;description=A+guide+to+using+webhooks+for+real-time+notifications+and+integrations\u0026amp;theme=3bb20ee5604d48b6f4993832\u0026amp;signature=1d6b4a598431d95334f9b9d4d9c668ebf22bbede5420afd6df01f92b9ff6b6e5\">\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=\"Overview - Starter Kit\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"A guide to using webhooks for real-time notifications and integrations\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hirehive.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Overview\u0026amp;description=A+guide+to+using+webhooks+for+real-time+notifications+and+integrations\u0026amp;theme=3bb20ee5604d48b6f4993832\u0026amp;signature=1d6b4a598431d95334f9b9d4d9c668ebf22bbede5420afd6df01f92b9ff6b6e5\">\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/hirehive/8CvQvXCUMBAiaJJ7/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Starter Kit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1d4ed8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hirehive.com/api-reference/webhooks/introduction\">\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/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hirehive.com/#organization\",\"name\":\"Starter Kit\",\"url\":\"https://docs.hirehive.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hirehive/EwYKqLOxXCdMHqRI/logo/light.svg?fit=max\u0026auto=format\u0026n=EwYKqLOxXCdMHqRI\u0026q=85\u0026s=c51ca959c2189bc80849d307962fee76\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hirehive.com#website\",\"name\":\"Starter Kit\",\"url\":\"https://docs.hirehive.com\",\"publisher\":{\"@id\":\"https://docs.hirehive.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hirehive.com/api-reference/webhooks/introduction#webpage\",\"url\":\"https://docs.hirehive.com/api-reference/webhooks/introduction\",\"name\":\"Overview\",\"description\":\"A guide to using webhooks for real-time notifications and integrations\",\"dateModified\":\"2025-11-06T14:41:37.182Z\",\"isPartOf\":{\"@id\":\"https://docs.hirehive.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hirehive.com/api-reference/webhooks/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hirehive.com/api-reference/webhooks/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Starter Kit\",\"item\":\"https://docs.hirehive.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Overview\",\"item\":\"https://docs.hirehive.com/api-reference/webhooks/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.hirehive.com/api-reference/webhooks/introduction#article\",\"headline\":\"Overview\",\"name\":\"Overview\",\"description\":\"A guide to using webhooks for real-time notifications and integrations\",\"url\":\"https://docs.hirehive.com/api-reference/webhooks/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hirehive.com/api-reference/webhooks/introduction#webpage\"},\"dateModified\":\"2025-11-06T14:41:37.182Z\",\"publisher\":{\"@id\":\"https://docs.hirehive.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hirehive.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Starter Kit\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Starter Kit\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/webhooks/introduction.md","siteName":"Starter Kit","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","tabs":[{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Authentication","icon":"fingerprint","href":"/api-reference/authentication"},{"title":"Pagination","icon":"list-ol","href":"/api-reference/pagination"},{"title":"Sorting","icon":"arrow-up-z-a","href":"/api-reference/sorting-options"},{"title":"Object IDs","icon":"passport","href":"/api-reference/object-ids"}]},{"group":"Endpoints","pages":[{"group":"Applications","pages":[{"title":"Application object","href":"/api-reference/applications/application-object"},{"title":"Get applications","openapi":"get /v1.0/{company_id}/applications","href":"/api-reference/applications/get-v1-applications"},{"title":"Get application","openapi":"get /v1.0/{company_id}/candidates/{candidate_id}/applications/{application_id}","href":"/api-reference/applications/get-v1-candidates-applications"},{"title":"Get questions for application","openapi":"get /v1.0/{company_id}/candidates/{candidate_id}/applications/{application_id}/questions","href":"/api-reference/applications/get-v1-candidates-applications-questions"},{"title":"Get resume","openapi":"get /v1.0/{company_id}/candidates/{candidate_id}/applications/{application_id}/resume/{resume_id}/{file_version}","href":"/api-reference/applications/get-v1-candidates-applications-resume-"},{"title":"Update source","openapi":"put /v1.0/{company_id}/candidates/{candidate_id}/applications/{application_id}/source","href":"/api-reference/applications/put-v1-candidates-applications-source"},{"title":"Change application stage","openapi":"put /v1.0/{company_id}/candidates/{candidate_id}/applications/{application_id}/stage","href":"/api-reference/applications/put-v1-candidates-applications-stage"}]},{"group":"Candidates","pages":[{"title":"Candidate object","href":"/api-reference/candidates/candidate-object"},{"title":"Get candidates","openapi":"get /v1.0/{company_id}/candidates","href":"/api-reference/candidates/list"},{"title":"Get candidate by id","openapi":"get /v1.0/{company_id}/candidates/{candidate_id}","href":"/api-reference/candidates/get-by-id"},{"title":"Update candidate","openapi":"put /v1.0/{company_id}/candidates/{candidate_id}","href":"/api-reference/candidates/update"},{"group":"Candidate Notes","pages":[{"title":"Get notes","openapi":"get /v1.0/{company_id}/candidates/{candidate_id}/notes","href":"/api-reference/candidate-notes/list"},{"title":"Create note","openapi":"post /v1.0/{company_id}/candidates/{candidate_id}/notes","href":"/api-reference/candidate-notes/create"},{"title":"Update note","openapi":"put /v1.0/{company_id}/candidates/{candidate_id}/notes/{note_id}","href":"/api-reference/candidate-notes/update"},{"title":"Delete note","openapi":"delete /v1.0/{company_id}/candidates/{candidate_id}/notes/{note_id}","href":"/api-reference/candidate-notes/delete"}]},{"group":"Candidate Tags","pages":[{"title":"Tag candidate","openapi":"post /v1.0/{company_id}/candidates/{candidate_id}/tags","href":"/api-reference/candidate-tags/add-tag"},{"title":"Remove tag","openapi":"delete /v1.0/{company_id}/candidates/{candidate_id}/tags/{tag_id}","href":"/api-reference/candidate-tags/remove-tag"}]}]},{"group":"Jobs","pages":[{"title":"Job object","href":"/api-reference/jobs/job-object"},{"title":"Get jobs","openapi":"get /v1.0/{company_id}/jobs","href":"/api-reference/jobs/list"},{"title":"Get job by id","openapi":"get /v1.0/{company_id}/jobs/{job_id}","href":"/api-reference/jobs/get-by-id"},{"title":"Create job","openapi":"post /v1.0/{company_id}/jobs","href":"/api-reference/jobs/create"},{"title":"Update job","openapi":"put /v1.0/{company_id}/jobs/{job_id}","href":"/api-reference/jobs/update"},{"title":"Change job status","openapi":"put /v1.0/{company_id}/jobs/{job_id}/status","href":"/api-reference/jobs/change-status"},{"title":"Delete job","openapi":"delete /v1.0/{company_id}/jobs/{job_id}","href":"/api-reference/jobs/delete"},{"group":"Jobs Notes","pages":[{"title":"Get notes","openapi":"get /v1.0/{company_id}/jobs/{job_id}/notes","href":"/api-reference/jobnotes/list"},{"title":"Get note by id","openapi":"get /v1.0/{company_id}/jobs/{job_id}/notes/{note_id}","href":"/api-reference/jobnotes/get-by-id"},{"title":"Create note","openapi":"post /v1.0/{company_id}/jobs/{job_id}/notes","href":"/api-reference/jobnotes/create"},{"title":"Update note","openapi":"put /v1.0/{company_id}/jobs/{job_id}/notes/{note_id}","href":"/api-reference/jobnotes/update"},{"title":"Delete note","openapi":"delete /v1.0/{company_id}/jobs/{job_id}/notes/{note_id}","href":"/api-reference/jobnotes/delete"}]}]},{"group":"Feedback","pages":[{"title":"Get feedback","openapi":"get /v1.0/{company_id}/feedback","href":"/api-reference/feedback/get"},{"title":"Complete feedback","openapi":"post /v1.0/{company_id}/feedback","href":"/api-reference/feedback/create"},{"title":"Update feedback","openapi":"put /v1.0/{company_id}/feedback/{feedback_id}","href":"/api-reference/feedback/update"},{"title":"Request feedback","openapi":"post /v1.0/{company_id}/candidates/{candidate_id}/applications/{application_id}/feedback/request","href":"/api-reference/feedback/request"}]},{"group":"Interviews","pages":[{"title":"Get interviews","openapi":"get /v1.0/{company_id}/interviews","href":"/api-reference/interviews/list"},{"title":"Get interview by id","openapi":"get /v1.0/{company_id}/interviews/{interview_id}","href":"/api-reference/interviews/get-by-id"},{"title":"Create interview","openapi":"post /v1.0/{company_id}/interviews","href":"/api-reference/interviews/create"},{"title":"Update interview","openapi":"put /v1.0/{company_id}/interviews/{interview_id}","href":"/api-reference/interviews/update"},{"title":"Cancel interview","openapi":"put /v1.0/{company_id}/interviews/{interview_id}/cancel","href":"/api-reference/interviews/cancel"}]},{"group":"Users","pages":[{"title":"User permissions","href":"/api-reference/users/permissions"},{"title":"Get users","openapi":"get /v1.0/{company_id}/users","href":"/api-reference/users/list"},{"title":"Get user by id","openapi":"get /v1.0/{company_id}/users/{id}","href":"/api-reference/users/get-by-id"},{"title":"Create user","openapi":"post /v1.0/{company_id}/users","href":"/api-reference/users/create"},{"title":"Update user","openapi":"put /v1.0/{company_id}/users/{id}","href":"/api-reference/users/update"},{"title":"Delete user","openapi":"delete /v1.0/{company_id}/users/{id}","href":"/api-reference/users/delete"}]},{"group":"Files","pages":[{"title":"Get file by id","openapi":"get /v1.0/{company_id}/files/{file_id}","href":"/api-reference/files/get-by-id"},{"title":"Upload File","openapi":"post /v1.0/{company_id}/files","href":"/api-reference/files/upload"}]},{"group":"Settings","pages":[{"group":"User Categories","pages":[{"title":"Get user categories","openapi":"get /v1.0/{company_id}/users/categories","href":"/api-reference/usercategories/list"},{"title":"Get user categories by id","openapi":"get /v1.0/{company_id}/users/categories/{category_id}","href":"/api-reference/usercategories/get-by-id"},{"title":"Create a new user category","openapi":"post /v1.0/{company_id}/users/categories","href":"/api-reference/usercategories/create"},{"title":"Update a user category","openapi":"put /v1.0/{company_id}/users/categories/{id}","href":"/api-reference/usercategories/update"},{"title":"Delete category","openapi":"delete /v1.0/{company_id}/users/categories/{id}","href":"/api-reference/usercategories/delete"}]},{"group":"Job Categories","pages":[{"title":"Get categories","openapi":"get /v1.0/{company_id}/jobs/categories","href":"/api-reference/jobcategories/list"},{"title":"Get category","openapi":"get /v1.0/{company_id}/jobs/categories/{category_id}","href":"/api-reference/jobcategories/get-by-id"},{"title":"Create category","openapi":"post /v1.0/{company_id}/jobs/categories","href":"/api-reference/jobcategories/create"},{"title":"Update category","openapi":"put /v1.0/{company_id}/jobs/categories/{category_id}","href":"/api-reference/jobcategories/update"},{"title":"Order categories","openapi":"put /v1.0/{company_id}/jobs/categories","href":"/api-reference/jobcategories/update-order"},{"title":"Delete category","openapi":"delete /v1.0/{company_id}/jobs/categories/{category_id}","href":"/api-reference/jobcategories/delete"}]},{"group":"Email Templates","pages":[{"title":"Get templates","openapi":"get /v1.0/{company_id}/emailtemplates","href":"/api-reference/emailtemplates/list"},{"title":"Create template","openapi":"post /v1.0/{company_id}/emailtemplates","href":"/api-reference/emailtemplates/create"},{"title":"Update template","openapi":"put /v1.0/{company_id}/emailtemplates/{id}","href":"/api-reference/emailtemplates/update"},{"title":"Delete template","openapi":"delete /v1.0/{company_id}/emailtemplates/{id}","href":"/api-reference/emailtemplates/delete"}]},{"group":"Manage Tags","pages":[{"title":"Get tags","openapi":"get /v1.0/{company_id}/tags","href":"/api-reference/tags/list"},{"title":"Get tag","openapi":"get /v1.0/{company_id}/tags/{tag_id}","href":"/api-reference/tags/get-by-id"},{"title":"Create a tag","openapi":"post /v1.0/{company_id}/tags","href":"/api-reference/tags/create"},{"title":"Update tag","openapi":"put /v1.0/{company_id}/tags/{tag_id}","href":"/api-reference/tags/update"}]},{"group":"Pipeline stages","pages":[{"title":"Get stages","openapi":"get /v1.0/{company_id}/pipeline-stages","href":"/api-reference/pipeline/list"},{"title":"Get stage by id","openapi":"get /v1.0/{company_id}/pipeline-stages/{id}","href":"/api-reference/pipeline/get-by-id"},{"title":"Create new stage","openapi":"post /v1.0/{company_id}/pipeline-stages","href":"/api-reference/pipeline/create"},{"title":"Update state","openapi":"put /v1.0/{company_id}/pipeline-stages/{id}","href":"/api-reference/pipeline/update"},{"title":"Reorder stages","openapi":"put /v1.0/{company_id}/pipeline-stages","href":"/api-reference/pipeline/update-order"},{"title":"Delete a stage","openapi":"delete /v1.0/{company_id}/pipeline-stages/{id}","href":"/api-reference/pipeline/delete"}]},{"group":"Application and Feedback forms","pages":[{"title":"Get forms","openapi":"get /v1.0/{company_id}/forms/application","href":"/api-reference/forms/list"},{"title":"Get form","openapi":"get /v1.0/{company_id}/forms/application/{form_id}","href":"/api-reference/forms/get-by-id"},{"title":"Create form","openapi":"post /v1.0/{company_id}/forms/application","href":"/api-reference/forms/create"},{"title":"Update form","openapi":"put /v1.0/{company_id}/forms/application/{form_id}","href":"/api-reference/forms/update"},{"title":"Duplicate form","openapi":"put /v1.0/{company_id}/forms/application/{form_id}/duplicate","href":"/api-reference/forms/duplicate"},{"title":"Delete form","openapi":"delete /v1.0/{company_id}/forms/application/{form_id}","href":"/api-reference/forms/delete"},{"group":"Base form","pages":[{"title":"Get base form","openapi":"get /v1.0/{company_id}/forms/application/default","href":"/api-reference/forms/get-base"},{"title":"Update base form","openapi":"put /v1.0/{company_id}/forms/application/default","href":"/api-reference/forms/update-base"}]}]}]},{"group":"Webhooks","pages":[{"title":"Get webhooks","openapi":"get /v1.0/{company_id}/webhooks","href":"/api-reference/webhooks/list"},{"title":"Get webhook","openapi":"get /v1.0/{company_id}/webhooks/{webhook_id}","href":"/api-reference/webhooks/get-by-id"},{"title":"Get a paginated list of webhook events","openapi":"get /v1.0/{company_id}/webhooks/events","href":"/api-reference/webhooks/get-events"},{"title":"Create a webhook","openapi":"post /v1.0/{company_id}/webhooks","href":"/api-reference/webhooks/create"},{"title":"Update webhook","description":"Update a webhook by id","openapi":"put /v1.0/{company_id}/webhooks/{webhook_id}","href":"/api-reference/webhooks/update"}]}]},{"group":"Webhooks","pages":[{"title":"Overview","icon":"circle-info","href":"/api-reference/webhooks/introduction"},{"title":"Verify Webhook Signatures","icon":"key","description":null,"href":"/api-reference/webhooks/validating-webhook-signatures"},{"title":"Webhook retries","icon":"repeat","href":"/api-reference/webhooks/webhook-retries"},{"group":"Events","pages":[{"title":"job.created","href":"/api-reference/webhooks/events/job.created"},{"title":"job.updated","href":"/api-reference/webhooks/events/job.updated"},{"title":"job.status.updated","href":"/api-reference/webhooks/events/job.status.updated"},{"title":"job.deleted","href":"/api-reference/webhooks/events/job.deleted"},{"title":"application.created","href":"/api-reference/webhooks/events/application.created"},{"title":"application.stage.updated","href":"/api-reference/webhooks/events/application.stage.updated"},{"title":"application.deleted","href":"/api-reference/webhooks/events/application.deleted"},{"title":"candidate.updated","href":"/api-reference/webhooks/events/candidate.updated"},{"title":"candidate.note.created","href":"/api-reference/webhooks/events/candidate.note.created"},{"title":"candidate.note.updated","href":"/api-reference/webhooks/events/candidate.note.updated"},{"title":"candidate.note.deleted","href":"/api-reference/webhooks/events/candidate.note.deleted"},{"title":"candidate.tag.added","href":"/api-reference/webhooks/events/candidate.tag.added"},{"title":"candidate.tag.removed","href":"/api-reference/webhooks/events/candidate.tag.removed"},{"title":"feedback.requested","href":"/api-reference/webhooks/events/feedback.requested"},{"title":"feedback.submitted","href":"/api-reference/webhooks/events/feedback.submitted"},{"title":"feedback.updated","href":"/api-reference/webhooks/events/feedback.updated"},{"title":"interview.created","href":"/api-reference/webhooks/events/interview.created"},{"title":"interview.updated","href":"/api-reference/webhooks/events/interview.updated"},{"title":"interview.cancelled","href":"/api-reference/webhooks/events/interview.cancelled"}]}]}]},{"tab":"Website integration","pages":[{"title":"Website integration","href":"/website-integration/introduction"}]}]},{"anchor":"Documentation","icon":"book-open-cover","pages":[{"title":"Documentation","href":"/introduction"}]},{"anchor":"Community","href":"https://twitter.com/hirehive","icon":"twitter"},{"anchor":"Blog","href":"https://www.hirehive.com/recruiting-blog/","icon":"newspaper"}]},"basePath":"","title":"Overview - Starter Kit","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["07c022d89b"],"chunks":["Frame-DBAS9Liu.js","DynamicMarkdown-C4w9kavL.js"]}