A webhook destination is verified before it is stored: the server sends a signed ping event and requires a 2xx within ten seconds, otherwise 422 endpoint_unreachable and no destination. The signing secret is generated here and returned exactly once, in this answer. One destination per provider per workspace: posting a second one updates the first. Requires scope write and an Idempotency-Key.
Any client-chosen key, a uuid for example. Sending the same request twice with the same key has one effect and returns the same response twice; the same key with a different body returns 409.
Required string length: 1 - 255
Example:
"3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
Body
application/json
Option 1
Option 2
Option 3
The provider and its connection settings. Never the webhook secret.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Ziplined","description":"The Ziplined API and MCP server: people, companies, posts and engagement from your LinkedIn orbit.","colors":{"primary":"#0F0F10","light":"#FFFFFF","dark":"#000000"},"logo":{"light":"https://mintcdn.com/ziplined/fJxSFlvhUu_BA0ar/logo/light.svg?fit=max\u0026auto=format\u0026n=fJxSFlvhUu_BA0ar\u0026q=85\u0026s=8cfbd1d8ff3c8c84c6969b09a9d7b144","dark":"https://mintcdn.com/ziplined/fJxSFlvhUu_BA0ar/logo/dark.svg?fit=max\u0026auto=format\u0026n=fJxSFlvhUu_BA0ar\u0026q=85\u0026s=0f8945287f046a59d63882e9c00e26cb","href":"https://ziplined.io"},"favicon":"https://mintcdn.com/ziplined/fJxSFlvhUu_BA0ar/favicon.svg?fit=max\u0026auto=format\u0026n=fJxSFlvhUu_BA0ar\u0026q=85\u0026s=fd4889987152858068ed10f82d393762","appearance":{"default":"system"},"background":{"color":{"light":"#FDFCFC","dark":"#0F0F10"}},"navbar":{"links":[{"href":"https://app.ziplined.io","label":"Open Ziplined"}]},"footer":{"socials":{"website":"https://ziplined.io"}},"fonts":{"family":"Inter"},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ziplined","hasAudioNarration":false,"actualSubdomain":"ziplined","customDomains":["docs.ziplined.io"],"gitSource":{"type":"github","owner":"jorritvginkel","repo":"ziplined-mcp","deployBranch":"develop","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6aa81264293612ad8f42d493","collectionId":"71d39c32-1fed-4bb7-a35d-2b11453d3036","liveDeploymentHistoryId":"6aa81264293612ad8f42d493","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6aa81264293612ad8f42d493","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"API reference","count":30},{"language":"default","tag":"Guides","count":16},{"language":"default","tag":"Integrations","count":11},{"language":"default","tag":"Audiences","count":5},{"language":"default","tag":"People","count":5},{"language":"default","tag":"Sources","count":5},{"language":"default","tag":"Webhooks","count":4},{"language":"default","tag":"Use the API","count":3},{"language":"default","tag":"Use with Claude","count":3},{"language":"default","tag":"Get started","count":2}]},"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":"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":"vite-origin","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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/integrations/connect-a-destination","slug":"/api-reference/integrations/connect-a-destination","pageMetadata":{"title":"Connect a destination","description":"A `webhook` destination is verified before it is stored: the server sends a signed `ping` event and requires a 2xx within ten seconds, otherwise 422 `endpoint_unreachable` and no destination. The signing secret is generated here and returned exactly once, in this answer. One destination per provider per workspace: posting a second one updates the first. Requires scope `write` and an `Idempotency-Key`.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/integrations","href":"/api-reference/integrations/connect-a-destination","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"A \", _jsx(_components.code, {\n children: \"webhook\"\n }), \" destination is verified before it is stored: the server sends a signed \", _jsx(_components.code, {\n children: \"ping\"\n }), \" event and requires a 2xx within ten seconds, otherwise 422 \", _jsx(_components.code, {\n children: \"endpoint_unreachable\"\n }), \" and no destination. The signing secret is generated here and returned exactly once, in this answer. One destination per provider per workspace: posting a second one updates the first. Requires scope \", _jsx(_components.code, {\n children: \"write\"\n }), \" and an \", _jsx(_components.code, {\n children: \"Idempotency-Key\"\n }), \".\"]\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":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"Connect a destination","description":"A `webhook` destination is verified before it is stored: the server sends a signed `ping` event and requires a 2xx within ten seconds, otherwise 422 `endpoint_unreachable` and no destination. The signing secret is generated here and returned exactly once, in this answer. One destination per provider per workspace: posting a second one updates the first. Requires scope `write` and an `Idempotency-Key`.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/integrations","href":"/api-reference/integrations/connect-a-destination","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Integrations"],"summary":"Connect a destination","description":"A `webhook` destination is verified before it is stored: the server sends a signed `ping` event and requires a 2xx within ten seconds, otherwise 422 `endpoint_unreachable` and no destination. The signing secret is generated here and returned exactly once, in this answer. One destination per provider per workspace: posting a second one updates the first. Requires scope `write` and an `Idempotency-Key`.","parameters":["6d98a172-c071-4377-afe9-d05dd47b8bd5"],"requestBody":"eb4272cb-359d-4401-a21f-92994c60d8df","responses":{"201":"d6172720-8aec-4b9b-b9d6-bc0c2fe4c740","400":"d6254338-a762-4b67-879e-a5f96698bb09","401":"fd2df0be-4f22-4778-bf72-d22f03f6227c","402":"6ce3417e-2936-4d04-bc9b-a4402e0d60f6","403":"fc228aa4-6111-43a6-b747-79c80b739024","404":"57457eee-c6ca-48c4-9d0c-000b8189e063","409":"7945c374-a93e-4fed-8afa-f1a505e764f2","422":"d9338065-20b3-421f-9c02-0be3245bbb2f"},"method":"post","type":"path","servers":["6a17ed36-8489-4400-8c1a-0ce000214074"],"security":[],"path":"/v1/integrations","baseUrlOptions":["https://api.ziplined.io"],"title":"Connect a destination","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6d98a172-c071-4377-afe9-d05dd47b8bd5":{"schema":{"type":"string","minLength":1,"maxLength":255,"description":"Any client-chosen key, a uuid for example. Sending the same request twice with the same key has one effect and returns the same response twice; the same key with a different body returns 409.","example":"3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"description":"Any client-chosen key, a uuid for example. Sending the same request twice with the same key has one effect and returns the same response twice; the same key with a different body returns 409.","name":"idempotency-key","in":"header"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"The provider and its connection settings. Never the webhook secret.","required":["provider","config"],"properties":{"provider":{"type":"string","enum":["webhook"],"isRequired":true,"uniqueKey":"oneOf.0.provider","typeLabel":"enum\u003cstring>"},"config":{"type":"object","properties":{"url":{"type":"string","format":"uri","example":"https://hook.eu2.make.com/abc123","isRequired":true,"uniqueKey":"oneOf.0.config.url","typeLabel":"string\u003curi>"}},"required":["url"],"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.config","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"The provider and its connection settings. Never the webhook secret.","required":["provider","config"],"properties":{"provider":{"type":"string","enum":["slack"],"isRequired":true,"uniqueKey":"oneOf.1.provider","typeLabel":"enum\u003cstring>"},"config":{"type":"object","properties":{"webhook_url":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"oneOf.1.config.webhook_url","typeLabel":"string\u003curi>"},"channel_label":{"type":"string","minLength":1,"uniqueKey":"oneOf.1.config.channel_label","typeLabel":"string"}},"required":["webhook_url"],"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.1.config","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","description":"The provider and its connection settings. Never the webhook secret.","required":["provider","config"],"properties":{"provider":{"type":"string","enum":["email"],"isRequired":true,"uniqueKey":"oneOf.2.provider","typeLabel":"enum\u003cstring>"},"config":{"type":"object","properties":{"to":{"type":"array","items":{"type":"string","format":"email","uniqueKey":"oneOf.2.config.to.items.[INDEX]","typeLabel":"string\u003cemail>"},"minItems":1,"maxItems":20,"isRequired":true,"uniqueKey":"oneOf.2.config.to","typeLabel":"string\u003cemail>[]"}},"required":["to"],"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.2.config","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.2","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"provider":"webhook","config":{"url":"https://hook.eu2.make.com/abc123"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"d6172720-8aec-4b9b-b9d6-bc0c2fe4c740":{"description":"The destination, plus its secret if it has one.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"secret":{"oneOf":[{"type":"string","description":"The webhook signing secret, shown exactly once. Null for a provider that has none, and null in the repeated answer to the same `Idempotency-Key`.","example":"whsec_…","isRequired":true,"uniqueKey":"data.secret.oneOf.0","typeLabel":"string"},{"type":"null","description":"The webhook signing secret, shown exactly once. Null for a provider that has none, and null in the repeated answer to the same `Idempotency-Key`.","example":"whsec_…","isRequired":true,"uniqueKey":"data.secret.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.secret","typeLabel":"string | null"},"integration":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.integration.id","typeLabel":"string"},"provider":{"type":"string","example":"slack","isRequired":true,"uniqueKey":"data.integration.provider","typeLabel":"string"},"status":{"type":"string","enum":["active","paused","error"],"isRequired":true,"uniqueKey":"data.integration.status","typeLabel":"enum\u003cstring>"},"config_summary":{"type":"object","properties":{"host":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.integration.config_summary.host.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.integration.config_summary.host.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.integration.config_summary.host","typeLabel":"string | null"}},"required":["host"],"additionalProperties":false,"description":"Where this destination points. Never the URL itself.","isRequired":true,"uniqueKey":"data.integration.config_summary","typeLabel":"object"},"created_at":{"type":"string","isRequired":true,"uniqueKey":"data.integration.created_at","typeLabel":"string"}},"required":["id","provider","status","config_summary","created_at"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data.integration","typeLabel":"object"}},"required":["secret","integration"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"secret":"whsec_…","integration":{"id":"\u003cstring>","provider":"slack","status":"active","config_summary":{"host":"\u003cstring>"},"created_at":"\u003cstring>"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"d6254338-a762-4b67-879e-a5f96698bb09":{"description":"A filter value is invalid, or this resource has no such filter.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"fd2df0be-4f22-4778-bf72-d22f03f6227c":{"description":"Missing or invalid bearer token.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"6ce3417e-2936-4d04-bc9b-a4402e0d60f6":{"description":"Not included in this plan, or a usage cap was exceeded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"fc228aa4-6111-43a6-b747-79c80b739024":{"description":"Wrong workspace, or the credential lacks the required scope.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"57457eee-c6ca-48c4-9d0c-000b8189e063":{"description":"No such record, or it does not belong to this workspace.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7945c374-a93e-4fed-8afa-f1a505e764f2":{"description":"The same `Idempotency-Key` was used for a different request, or that request is still in flight.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"d9338065-20b3-421f-9c02-0be3245bbb2f":{"description":"The endpoint gave no 2xx within ten seconds. No destination was created.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"6a17ed36-8489-4400-8c1a-0ce000214074":{"url":"https://api.ziplined.io","description":"Production"}}},"originalFileLocation":"openapi.json"},"subdomain":"ziplined","siteName":"Ziplined","title":"Connect a destination - Ziplined","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-14T08:38:56.800Z","originalFileLocation":"api-reference/integrations/connect-a-destination.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 webhook destination is verified before it is stored: the server sends a signed ping event and requires a 2xx within ten seconds, otherwise 422 endpoint_unreachable and no destination. The signing secret is generated here and returned exactly once, in this answer. One destination per provider per workspace: posting a second one updates the first. Requires scope write and an Idempotency-Key.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ziplined\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ziplined/kl-vN4Jlxb0Auhf_/_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/ziplined/kl-vN4Jlxb0Auhf_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ziplined/kl-vN4Jlxb0Auhf_/_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/ziplined/kl-vN4Jlxb0Auhf_/_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/ziplined/kl-vN4Jlxb0Auhf_/_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/ziplined/kl-vN4Jlxb0Auhf_/_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/ziplined/kl-vN4Jlxb0Auhf_/_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/ziplined/kl-vN4Jlxb0Auhf_/_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/ziplined/kl-vN4Jlxb0Auhf_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Connect a destination - Ziplined\">\u003cmeta data-mint-head property=\"og:description\" content=\"A webhook destination is verified before it is stored: the server sends a signed ping event and requires a 2xx within ten seconds, otherwise 422 endpoint_unreachable and no destination. The signing secret is generated here and returned exactly once, in this answer. One destination per provider per workspace: posting a second one updates the first. Requires scope write and an Idempotency-Key.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ziplined\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ziplined.io/api-reference/integrations/connect-a-destination\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ziplined.mintlify.app/_mintlify/api/og/v2?division=Integrations\u0026amp;title=Connect+a+destination\u0026amp;description=A+%60webhook%60+destination+is+verified+before+it+is+stored%3A+the+server+sends+a+signed+%60ping%60+event+and+requires+a+2xx+within+ten+seconds%2C+otherwise+422+%60endpoint_u\u0026amp;theme=e43609253cb7897c463db202\u0026amp;signature=a4a5c0ee313d97734cfdfd0e41dfeb414896290b245cfc5d49cf1c62ab2b555e\">\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=\"Connect a destination - Ziplined\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"A webhook destination is verified before it is stored: the server sends a signed ping event and requires a 2xx within ten seconds, otherwise 422 endpoint_unreachable and no destination. The signing secret is generated here and returned exactly once, in this answer. One destination per provider per workspace: posting a second one updates the first. Requires scope write and an Idempotency-Key.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ziplined.mintlify.app/_mintlify/api/og/v2?division=Integrations\u0026amp;title=Connect+a+destination\u0026amp;description=A+%60webhook%60+destination+is+verified+before+it+is+stored%3A+the+server+sends+a+signed+%60ping%60+event+and+requires+a+2xx+within+ten+seconds%2C+otherwise+422+%60endpoint_u\u0026amp;theme=e43609253cb7897c463db202\u0026amp;signature=a4a5c0ee313d97734cfdfd0e41dfeb414896290b245cfc5d49cf1c62ab2b555e\">\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/ziplined/kl-vN4Jlxb0Auhf_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ziplined\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0F0F10\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ziplined.io/api-reference/integrations/connect-a-destination\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/integrations/connect-a-destination.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ziplined.io/#organization\",\"name\":\"Ziplined\",\"url\":\"https://docs.ziplined.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ziplined/fJxSFlvhUu_BA0ar/logo/light.svg?fit=max\u0026auto=format\u0026n=fJxSFlvhUu_BA0ar\u0026q=85\u0026s=8cfbd1d8ff3c8c84c6969b09a9d7b144\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ziplined.io#website\",\"name\":\"Ziplined\",\"url\":\"https://docs.ziplined.io\",\"publisher\":{\"@id\":\"https://docs.ziplined.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ziplined.io/api-reference/integrations/connect-a-destination#webpage\",\"url\":\"https://docs.ziplined.io/api-reference/integrations/connect-a-destination\",\"name\":\"Connect a destination\",\"description\":\"A webhook destination is verified before it is stored: the server sends a signed ping event and requires a 2xx within ten seconds, otherwise 422 endpoint_unreachable and no destination. The signing secret is generated here and returned exactly once, in this answer. One destination per provider per workspace: posting a second one updates the first. Requires scope write and an Idempotency-Key.\",\"dateModified\":\"2026-09-14T08:38:56.800Z\",\"isPartOf\":{\"@id\":\"https://docs.ziplined.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ziplined.io/api-reference/integrations/connect-a-destination#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ziplined.io/api-reference/integrations/connect-a-destination#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Integrations\",\"item\":\"https://docs.ziplined.io/api-reference/integrations/the-destinations-of-this-workspace\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Connect a destination\",\"item\":\"https://docs.ziplined.io/api-reference/integrations/connect-a-destination\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ziplined.io/api-reference/integrations/connect-a-destination#apireference\",\"headline\":\"Connect a destination\",\"name\":\"Connect a destination\",\"description\":\"A webhook destination is verified before it is stored: the server sends a signed ping event and requires a 2xx within ten seconds, otherwise 422 endpoint_unreachable and no destination. The signing secret is generated here and returned exactly once, in this answer. One destination per provider per workspace: posting a second one updates the first. Requires scope write and an Idempotency-Key.\",\"url\":\"https://docs.ziplined.io/api-reference/integrations/connect-a-destination\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ziplined.io/api-reference/integrations/connect-a-destination#webpage\"},\"dateModified\":\"2026-09-14T08:38:56.800Z\",\"publisher\":{\"@id\":\"https://docs.ziplined.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ziplined.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ziplined\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Ziplined","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"API reference","groups":[{"group":"People","pages":[{"title":"The people in this workspace","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/people","href":"/api-reference/people/the-people-in-this-workspace"},{"title":"A single person","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/people/{person_id}","href":"/api-reference/people/a-single-person"},{"title":"Update many people at once","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/people","href":"/api-reference/people/update-many-people-at-once"},{"title":"Update one person","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/people/{person_id}","href":"/api-reference/people/update-one-person"},{"title":"Log that we reached out to someone","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/people/{person_id}/touches","href":"/api-reference/people/log-that-we-reached-out-to-someone"}]},{"group":"Companies","pages":[{"title":"The companies where the people of this workspace work","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/companies","href":"/api-reference/companies/the-companies-where-the-people-of-this-workspace-work"},{"title":"A single company","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/companies/{id}","href":"/api-reference/companies/a-single-company"}]},{"group":"Posts","pages":[{"title":"The posts of this workspace","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/posts","href":"/api-reference/posts/the-posts-of-this-workspace"},{"title":"A single post","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/posts/{post_id}","href":"/api-reference/posts/a-single-post"}]},{"group":"Engagements","pages":[{"title":"What these people did with which posts","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/engagements","href":"/api-reference/engagements/what-these-people-did-with-which-posts"}]},{"group":"Insights","pages":[{"title":"What worked this period","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/insights","href":"/api-reference/insights/what-worked-this-period"},{"title":"The daily numbers of your own account","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/metrics","href":"/api-reference/insights/the-daily-numbers-of-your-own-account"}]},{"group":"Audiences","pages":[{"title":"The audiences of this workspace","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/audiences","href":"/api-reference/audiences/the-audiences-of-this-workspace"},{"title":"A single audience","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/audiences/{id}","href":"/api-reference/audiences/a-single-audience"},{"title":"The people in an audience","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/audiences/{id}/members","href":"/api-reference/audiences/the-people-in-an-audience"},{"title":"Add people to an audience","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/audiences/{id}/members","href":"/api-reference/audiences/add-people-to-an-audience"},{"title":"Remove people from an audience","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/audiences/{id}/members","href":"/api-reference/audiences/remove-people-from-an-audience"}]},{"group":"Sources","pages":[{"title":"What this workspace tracks","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sources","href":"/api-reference/sources/what-this-workspace-tracks"},{"title":"Track a new source","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sources","href":"/api-reference/sources/track-a-new-source"},{"title":"A single source","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sources/{id}","href":"/api-reference/sources/a-single-source"},{"title":"Pause or resume a source","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/sources/{id}","href":"/api-reference/sources/pause-or-resume-a-source"},{"title":"Stop tracking a source","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/sources/{id}","href":"/api-reference/sources/stop-tracking-a-source"}]},{"group":"Integrations","pages":[{"title":"The destinations of this workspace","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /v1/integrations","href":"/api-reference/integrations/the-destinations-of-this-workspace"},{"title":"Connect a destination","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/integrations","href":"/api-reference/integrations/connect-a-destination"},{"title":"A single destination","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /v1/integrations/{id}","href":"/api-reference/integrations/a-single-destination"},{"title":"Rotate a webhook signing secret","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/integrations/{id}/rotate-secret","href":"/api-reference/integrations/rotate-a-webhook-signing-secret"},{"title":"Send a test event to a destination","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/integrations/{id}/test","href":"/api-reference/integrations/send-a-test-event-to-a-destination"},{"title":"The routing rules of one destination","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/integrations/{id}/rules","href":"/api-reference/integrations/the-routing-rules-of-one-destination"},{"title":"Put a routing rule on a destination","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/integrations/{id}/rules","href":"/api-reference/integrations/put-a-routing-rule-on-a-destination"},{"title":"Pause a rule or turn it back on","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/integrations/{id}/rules/{rule_id}","href":"/api-reference/integrations/pause-a-rule-or-turn-it-back-on"}]}]}]},"basePath":"","title":"Connect a destination - Ziplined","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-Buji1S4J.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}