Registers a URL that receives a POST request each time the given rest hook event happens in the community. The response contains the id of the subscription, which can be used to unsubscribe
API authentication using your community API secret. The value below is sent as the Authorization header verbatim, so paste the whole header value including the prefix: Token token=
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Zapnito Developer Docs","description":"Zapnito developer documentation. Integrate expert knowledge communities using the API, webhooks and MCP server, with guides, references and examples.","colors":{"primary":"#A28BFE","light":"#A28BFE","dark":"#A28BFE"},"logo":{"light":"https://mintcdn.com/zapnito-3f02a250/tVIYGk7DEJxtk1do/images/Zapnito-Horizontal-Gray.png?fit=max\u0026auto=format\u0026n=tVIYGk7DEJxtk1do\u0026q=85\u0026s=ff03ba675b6fd54f1e518b37e67dba4c","dark":"https://mintcdn.com/zapnito-3f02a250/tVIYGk7DEJxtk1do/images/Zapnito-Horizontal-White.png?fit=max\u0026auto=format\u0026n=tVIYGk7DEJxtk1do\u0026q=85\u0026s=bf0f9160c98cf86c277a6028e5e7ddd0"},"favicon":{"light":"https://mintcdn.com/zapnito-3f02a250/3A3P17JjWbqJP6iZ/images/favicon.svg?fit=max\u0026auto=format\u0026n=3A3P17JjWbqJP6iZ\u0026q=85\u0026s=c421cde1e0bc51e19e3d77c9512b1ad7","dark":"https://mintcdn.com/zapnito-3f02a250/3A3P17JjWbqJP6iZ/images/favicon.svg?fit=max\u0026auto=format\u0026n=3A3P17JjWbqJP6iZ\u0026q=85\u0026s=c421cde1e0bc51e19e3d77c9512b1ad7"},"api":{"playground":{"display":"interactive"}},"appearance":{"default":"dark","strict":false},"background":{"color":{"dark":"#18181B"}},"navbar":{"links":[{"href":"https://knowledge.zapnito.com","label":"Community"}],"primary":{"type":"button","label":"Get a Demo","href":"https://zapnito.com/demo"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/zapnito"}},"seo":{"metatags":{"og:site_name":"Zapnito Docs"},"organization":{"name":"Zapnito","url":"https://zapnito.com","sameAs":["https://linkedin.com/company/zapnito"]},"indexing":"all"},"fonts":{"heading":{"family":"Inter"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"thumbnails":{"appearance":"dark","fonts":{"family":"Inter"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zapnito-3f02a250","hasAudioNarration":false,"actualSubdomain":"zapnito-3f02a250","customDomains":["docs.zapnito.com"],"gitSource":{"type":"github","owner":"zapnito","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ada8b7c0187b2d0736a5161","collectionId":"9c23d7b9-53ab-4e75-a3bc-9e3365b5d87e","liveDeploymentHistoryId":"6ada8b7c0187b2d0736a5161","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ae20daa8ffbca586928b31e","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"API","count":61},{"language":"default","tag":"V1 API","count":56},{"language":"default","tag":"Webhooks","count":15},{"language":"default","tag":"Getting started","count":10},{"language":"default","tag":"Users","count":10},{"language":"default","tag":"Badges","count":8},{"language":"default","tag":"Groups","count":6},{"language":"default","tag":"Organisations","count":6},{"language":"default","tag":"Third-Party Resources","count":6},{"language":"default","tag":"Docs","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"editor-v7-file-tree","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":"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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api/v1/rest-hooks/subscribe-to-a-rest-hook","slug":"/api/v1/rest-hooks/subscribe-to-a-rest-hook","pageMetadata":{"title":"Subscribe to a rest hook","description":"Registers a URL that receives a POST request each time the given rest hook event happens in the community. The response contains the id of the subscription, which can be used to unsubscribe","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json post /api/v1/rest_hooks/{key}/subscriptions","href":"/api/v1/rest-hooks/subscribe-to-a-rest-hook","autogeneratedByOpenApi":true},"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: \"Registers a URL that receives a POST request each time the given rest hook event happens in the community. The response contains the id of the subscription, which can be used to unsubscribe\"\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":"Subscribe to a rest hook","description":"Registers a URL that receives a POST request each time the given rest hook event happens in the community. The response contains the id of the subscription, which can be used to unsubscribe","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json post /api/v1/rest_hooks/{key}/subscriptions","href":"/api/v1/rest-hooks/subscribe-to-a-rest-hook","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Subscribe to a rest hook","tags":["Rest Hooks"],"operationId":"subscribeToRestHook","description":"Registers a URL that receives a POST request each time the given rest hook event happens in the community. The response contains the id of the subscription, which can be used to unsubscribe","security":["56f86976-9205-4039-9727-35472eb4fdf2"],"parameters":[],"responses":{"200":"cec08c85-7fcb-40b1-b720-ff87f8698d78","201":"09092075-5af1-4784-bcc2-eaa1e5771225","400":"f5157cbc-9156-4aa7-b5f3-1fd4eee1b2f1","401":"bd99b57d-5427-4efb-b865-ff01b5457a75"},"requestBody":"4145db67-2034-43bf-bf63-0a13bf043a07","method":"post","type":"path","servers":["e1d66cab-603f-4bd4-942c-85bf8a80649b"],"path":"/api/v1/rest_hooks/{key}/subscriptions","baseUrlOptions":["https://{host}"],"title":"Subscribe to a rest hook","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a441885a-d991-42c2-91f2-ec06d34fa11d":{"name":"key","in":"path","required":true,"description":"The rest hook key (for example user_registered, user_updated, user_deleted)","schema":{"type":"string","isRequired":true,"description":"The rest hook key (for example user_registered, user_updated, user_deleted)","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"rest_hook_subscription":{"type":"object","properties":{"url":{"type":"string","example":"https://example.com/hooks/user-registered","isRequired":true,"uniqueKey":"rest_hook_subscription.url","typeLabel":"string"},"authorization_token":{"type":"string","example":"abcdefghijklmnopqrstuvwxyz","description":"Optional token sent with each delivery so your endpoint can verify the request","uniqueKey":"rest_hook_subscription.authorization_token","typeLabel":"string"}},"required":["url"],"isRequired":true,"uniqueKey":"rest_hook_subscription","typeLabel":"object"}},"required":["rest_hook_subscription"],"uniqueKey":"","typeLabel":"object"},"examples":{"new_subscription":{"title":"new_subscription","value":{"rest_hook_subscription":{"url":"https://example.com/hooks/user-registered"}}}},"exampleType":"examples"}},"required":true,"description":"Subscription payload wrapped in a rest_hook_subscription object","exampleType":"examples"},"responses":{"cec08c85-7fcb-40b1-b720-ff87f8698d78":{"description":"The request failed validation, so no subscription was created. The errors are in the response body","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"object","properties":{"url":{"type":"array","items":{"type":"string","uniqueKey":"errors.url.items.[INDEX]","typeLabel":"string"},"example":["can't be blank"],"uniqueKey":"errors.url","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"errors","typeLabel":"object"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":{"url":["can't be blank"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"09092075-5af1-4784-bcc2-eaa1e5771225":{"description":"The subscription was created","content":{"application/json":{"examples":{"example":{"title":"example","value":{"id":42}}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":42,"isRequired":true,"uniqueKey":"id","typeLabel":"integer"}},"required":["id"],"uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"exampleType":"examples"},"f5157cbc-9156-4aa7-b5f3-1fd4eee1b2f1":{"description":"The rest_hook_subscription object is missing. The response has no body","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"bd99b57d-5427-4efb-b865-ff01b5457a75":{"description":"The API key is missing or invalid. The response body is the text `HTTP Token: Access denied.`","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"56f86976-9205-4039-9727-35472eb4fdf2":{"tokenAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"API authentication using your community API secret. The value below is sent as the Authorization header verbatim, so paste the whole header value including the prefix: Token token=\u003capi-key>","x-default":"Token token=\u003capi-key>","scopes":[],"schemeName":"tokenAuth"}}},"servers":{"e1d66cab-603f-4bd4-942c-85bf8a80649b":{"url":"https://{host}","description":"Your community domain","variables":{"host":{"default":"your-community.com","description":"Your community domain, for example your-community.com"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"Authorization","in":"header","description":"API authentication using your community API secret. The value below is sent as the Authorization header verbatim, so paste the whole header value including the prefix: Token token=\u003capi-key>","x-default":"Token token=\u003capi-key>","scopes":[],"schemeName":"tokenAuth"},"schema":{"title":"Authorization","type":"string","description":"API authentication using your community API secret. The value below is sent as the Authorization header verbatim, so paste the whole header value including the prefix: Token token=\u003capi-key>","isRequired":true,"default":"Token token=\u003capi-key>","typeLabel":"string","deprecated":false},"schemeName":"tokenAuth","name":"Authorization"}],"title":"tokenAuth"}]},"originalFileLocation":"https://api.zapnito.com/api/docs/v1/swagger.json"},"subdomain":"zapnito-3f02a250","siteName":"Zapnito Developer Docs","title":"Subscribe to a rest hook - Zapnito Developer Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T14:58:55.642Z","originalFileLocation":"api/v1/rest-hooks/subscribe-to-a-rest-hook.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=\"dark\"}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=\"Registers a URL that receives a POST request each time the given rest hook event happens in the community. The response contains the id of the subscription, which can be used to unsubscribe\">\u003cmeta data-mint-head name=\"application-name\" content=\"Zapnito Developer Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zapnito-3f02a250/wgbbMe5r6eLuLS5J/_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/zapnito-3f02a250/wgbbMe5r6eLuLS5J/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zapnito-3f02a250/wgbbMe5r6eLuLS5J/_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/zapnito-3f02a250/wgbbMe5r6eLuLS5J/_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/zapnito-3f02a250/wgbbMe5r6eLuLS5J/_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/zapnito-3f02a250/wgbbMe5r6eLuLS5J/_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/zapnito-3f02a250/wgbbMe5r6eLuLS5J/_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/zapnito-3f02a250/wgbbMe5r6eLuLS5J/_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/zapnito-3f02a250/wgbbMe5r6eLuLS5J/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Subscribe to a rest hook - Zapnito Developer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Registers a URL that receives a POST request each time the given rest hook event happens in the community. The response contains the id of the subscription, which can be used to unsubscribe\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Zapnito Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.zapnito.com/api/v1/rest-hooks/subscribe-to-a-rest-hook\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zapnito-3f02a250.mintlify.app/_mintlify/api/og/v2?division=Rest+Hooks\u0026amp;title=Subscribe+to+a+rest+hook\u0026amp;description=Registers+a+URL+that+receives+a+POST+request+each+time+the+given+rest+hook+event+happens+in+the+community.+The+response+contains+the+id+of+the+subscription%2C+whi\u0026amp;theme=6fa956a31e3605b39bec0ece\u0026amp;signature=53f2e6e8d43e5b426681a361e36ce3565dd186d27a744b4741b597b88b0c2e35\">\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=\"Subscribe to a rest hook - Zapnito Developer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Registers a URL that receives a POST request each time the given rest hook event happens in the community. The response contains the id of the subscription, which can be used to unsubscribe\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zapnito-3f02a250.mintlify.app/_mintlify/api/og/v2?division=Rest+Hooks\u0026amp;title=Subscribe+to+a+rest+hook\u0026amp;description=Registers+a+URL+that+receives+a+POST+request+each+time+the+given+rest+hook+event+happens+in+the+community.+The+response+contains+the+id+of+the+subscription%2C+whi\u0026amp;theme=6fa956a31e3605b39bec0ece\u0026amp;signature=53f2e6e8d43e5b426681a361e36ce3565dd186d27a744b4741b597b88b0c2e35\">\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/zapnito-3f02a250/wgbbMe5r6eLuLS5J/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Zapnito Developer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#A28BFE\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.zapnito.com/api/v1/rest-hooks/subscribe-to-a-rest-hook\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/v1/rest-hooks/subscribe-to-a-rest-hook.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://zapnito.com/#organization\",\"name\":\"Zapnito\",\"url\":\"https://zapnito.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/zapnito-3f02a250/tVIYGk7DEJxtk1do/images/Zapnito-Horizontal-Gray.png?fit=max\u0026auto=format\u0026n=tVIYGk7DEJxtk1do\u0026q=85\u0026s=ff03ba675b6fd54f1e518b37e67dba4c\"},\"sameAs\":[\"https://linkedin.com/company/zapnito\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.zapnito.com#website\",\"name\":\"Zapnito Developer Docs\",\"url\":\"https://docs.zapnito.com\",\"publisher\":{\"@id\":\"https://zapnito.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.zapnito.com/api/v1/rest-hooks/subscribe-to-a-rest-hook#webpage\",\"url\":\"https://docs.zapnito.com/api/v1/rest-hooks/subscribe-to-a-rest-hook\",\"name\":\"Subscribe to a rest hook\",\"description\":\"Registers a URL that receives a POST request each time the given rest hook event happens in the community. The response contains the id of the subscription, which can be used to unsubscribe\",\"dateModified\":\"2026-10-28T14:58:55.642Z\",\"isPartOf\":{\"@id\":\"https://docs.zapnito.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.zapnito.com/api/v1/rest-hooks/subscribe-to-a-rest-hook#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.zapnito.com/api/v1/rest-hooks/subscribe-to-a-rest-hook#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"V1 API\",\"item\":\"https://docs.zapnito.com/api/v1/badges/list-badges\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Subscribe to a rest hook\",\"item\":\"https://docs.zapnito.com/api/v1/rest-hooks/subscribe-to-a-rest-hook\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.zapnito.com/api/v1/rest-hooks/subscribe-to-a-rest-hook#apireference\",\"headline\":\"Subscribe to a rest hook\",\"name\":\"Subscribe to a rest hook\",\"description\":\"Registers a URL that receives a POST request each time the given rest hook event happens in the community. The response contains the id of the subscription, which can be used to unsubscribe\",\"url\":\"https://docs.zapnito.com/api/v1/rest-hooks/subscribe-to-a-rest-hook\",\"mainEntityOfPage\":{\"@id\":\"https://docs.zapnito.com/api/v1/rest-hooks/subscribe-to-a-rest-hook#webpage\"},\"dateModified\":\"2026-10-28T14:58:55.642Z\",\"publisher\":{\"@id\":\"https://zapnito.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.zapnito.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Zapnito Developer Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Zapnito Developer Docs","nav":{"global":null,"tabs":[{"tab":"Docs","icon":"book-open","pages":[{"title":"Docs","href":""}]},{"tab":"API","icon":"code","groups":[{"group":"Getting started","pages":[{"title":"Zapnito API overview","sidebarTitle":"API overview","href":"/api/v1/overview"},{"title":"API authentication and headers","sidebarTitle":"Authentication","href":"/api/v1/authentication"},{"title":"Validate your API key","href":"/api/v1/ping"},{"title":"API pagination","sidebarTitle":"Pagination","href":"/api/v1/pagination"},{"title":"API responses and errors","sidebarTitle":"Responses and errors","href":"/api/v1/errors"}]},{"group":"V1 API","icon":"gear","pages":[{"group":"Badges","pages":[{"title":"List badges","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/badges","href":"/api/v1/badges/list-badges"},{"title":"Create a badge","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json post /api/v1/badges","href":"/api/v1/badges/create-a-badge"},{"title":"Get a badge","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/badges/{id}","href":"/api/v1/badges/get-a-badge"},{"title":"Update a badge","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json put /api/v1/badges/{id}","href":"/api/v1/badges/update-a-badge"},{"title":"Delete a badge","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json delete /api/v1/badges/{id}","href":"/api/v1/badges/delete-a-badge"},{"title":"Update a badge (PATCH)","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json patch /api/v1/badges/{id}","href":"/api/v1/badges/update-a-badge-patch"},{"title":"Assign a badge","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json post /api/v1/badges/{badge_id}/assign","href":"/api/v1/badges/assign-a-badge"},{"title":"Unassign a badge","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json delete /api/v1/badges/{badge_id}/unassign","href":"/api/v1/badges/unassign-a-badge"}]},{"group":"Channels","pages":[{"title":"List channel contents","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/channels/{channel_id}/contents","href":"/api/v1/channels/list-channel-contents"},{"title":"List channels","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/channels","href":"/api/v1/channels/list-channels"}]},{"group":"Contents","pages":[{"title":"List contents","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/contents","href":"/api/v1/contents/list-contents"},{"title":"Get a piece of content","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/contents/{id}","href":"/api/v1/contents/get-a-piece-of-content"},{"title":"Publish a piece of content","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json post /api/v1/contents/{id}/publish","href":"/api/v1/contents/publish-a-piece-of-content"},{"title":"Schedule a piece of content","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json post /api/v1/contents/{id}/schedule","href":"/api/v1/contents/schedule-a-piece-of-content"},{"title":"Unpublish a piece of content","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json post /api/v1/contents/{id}/unpublish","href":"/api/v1/contents/unpublish-a-piece-of-content"}]},{"group":"Custom Fields","pages":[{"title":"List custom fields","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/custom_fields","href":"/api/v1/custom-fields/list-custom-fields"}]},{"group":"Groups","pages":[{"title":"List group users","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/groups/{uuid}/users","href":"/api/v1/groups/list-group-users"},{"title":"Add a user to a group","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json post /api/v1/groups/{uuid}/users","href":"/api/v1/groups/add-a-user-to-a-group"},{"title":"Remove a user from a group","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json delete /api/v1/groups/{uuid}/users","href":"/api/v1/groups/remove-a-user-from-a-group"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json post /api/v1/groups","href":"/api/v1/groups/create-a-group"}]},{"group":"Identity","pages":[{"title":"Get the community identity","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/identity","href":"/api/v1/identity/get-the-community-identity"}]},{"group":"Invitations","pages":[{"title":"Invite a user","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json post /api/v1/invitations","href":"/api/v1/invitations/invite-a-user"}]},{"group":"Organisations","pages":[{"title":"Add a user to an organisation","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json post /api/v1/organisations/{organisation_id}/users","href":"/api/v1/organisations/add-a-user-to-an-organisation"},{"title":"Remove a user from an organisation","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json delete /api/v1/organisations/{organisation_id}/users","href":"/api/v1/organisations/remove-a-user-from-an-organisation"},{"title":"List organisations","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/organisations","href":"/api/v1/organisations/list-organisations"},{"title":"Create an organisation","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json post /api/v1/organisations","href":"/api/v1/organisations/create-an-organisation"},{"title":"Update an organisation","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json put /api/v1/organisations/{id}","href":"/api/v1/organisations/update-an-organisation"},{"title":"Update an organisation (PATCH)","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json patch /api/v1/organisations/{id}","href":"/api/v1/organisations/update-an-organisation-patch"}]},{"group":"Health Check","pages":[{"title":"Check the API key","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/ping","href":"/api/v1/health-check/check-the-api-key"}]},{"group":"Posts","pages":[{"title":"List posts","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/posts","href":"/api/v1/posts/list-posts"},{"title":"Create a post","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json post /api/v1/posts","href":"/api/v1/posts/create-a-post"},{"title":"Get a post","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/posts/{id}","href":"/api/v1/posts/get-a-post"},{"title":"Update a post","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json put /api/v1/posts/{id}","href":"/api/v1/posts/update-a-post"},{"title":"Update a post (PATCH)","description":"Identical to the PUT operation. Updates a post on behalf of its author. Only the attributes sent are changed, and relationships that are not sent are left alone. The author needs a separate permission for each optional setting and relationship they change","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json patch /api/v1/posts/{id}","href":"/api/v1/posts/update-a-post-patch"}]},{"group":"Rest Hooks","pages":[{"title":"Subscribe to a rest hook","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json post /api/v1/rest_hooks/{key}/subscriptions","href":"/api/v1/rest-hooks/subscribe-to-a-rest-hook"},{"title":"Unsubscribe from a rest hook","description":"Removes a subscription, so its URL stops receiving requests for the rest hook event","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json delete /api/v1/rest_hooks/{key}/subscriptions/{id}","href":"/api/v1/rest-hooks/unsubscribe-from-a-rest-hook"},{"title":"Get a sample rest hook payload","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/rest_hooks/{key}/sample","href":"/api/v1/rest-hooks/get-a-sample-rest-hook-payload"}]},{"group":"Rooms","pages":[{"title":"List rooms","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/rooms","href":"/api/v1/rooms/list-rooms"},{"title":"Create a room","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json post /api/v1/rooms","href":"/api/v1/rooms/create-a-room"},{"title":"Get a room","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/rooms/{id}","href":"/api/v1/rooms/get-a-room"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/tags","href":"/api/v1/tags/list-tags"},{"title":"Create a tag","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json post /api/v1/tags","href":"/api/v1/tags/create-a-tag"},{"title":"Tag content","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json put /api/v1/tags/contents","href":"/api/v1/tags/tag-content"}]},{"group":"Third-Party Resources","pages":[{"title":"List third-party resources","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/third_party_resources","href":"/api/v1/third-party-resources/list-third-party-resources"},{"title":"Create a third-party resource","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json post /api/v1/third_party_resources","href":"/api/v1/third-party-resources/create-a-third-party-resource"},{"title":"Get a third-party resource","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/third_party_resources/{id}","href":"/api/v1/third-party-resources/get-a-third-party-resource"},{"title":"Update a third-party resource","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json put /api/v1/third_party_resources/{id}","href":"/api/v1/third-party-resources/update-a-third-party-resource"},{"title":"Delete a third-party resource","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json delete /api/v1/third_party_resources/{id}","href":"/api/v1/third-party-resources/delete-a-third-party-resource"},{"title":"Update a third-party resource (PATCH)","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json patch /api/v1/third_party_resources/{id}","href":"/api/v1/third-party-resources/update-a-third-party-resource-patch"}]},{"group":"Users","pages":[{"title":"Update a notification preference","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json put /api/v1/users/{user_email}/notification_preferences","href":"/api/v1/users/update-a-notification-preference"},{"title":"Update a notification preference (PATCH)","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json patch /api/v1/users/{user_email}/notification_preferences","href":"/api/v1/users/update-a-notification-preference-patch"},{"title":"List users","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/users","href":"/api/v1/users/list-users"},{"title":"Update a user (deprecated)","deprecated":true,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json put /api/v1/users","href":"/api/v1/users/update-a-user-deprecated"},{"title":"Get a user","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json get /api/v1/users/{email}","href":"/api/v1/users/get-a-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json put /api/v1/users/{email}","href":"/api/v1/users/update-a-user"},{"title":"Update a user (PATCH)","deprecated":null,"version":null,"openapi":"https://api.zapnito.com/api/docs/v1/swagger.json patch /api/v1/users/{email}","href":"/api/v1/users/update-a-user-patch"}]}]}]},{"tab":"Webhooks","icon":"cloud","pages":[{"title":"Webhooks","href":"/webhooks/overview"}]}]},"title":"Subscribe to a rest hook - Zapnito Developer Docs","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}