Registers a webhook endpoint in the project and returns it with the signing secret used to verify payload signatures. The webhook receives the events listed in events. Connector events are subscribed separately: add the webhook id to webhook_ids in the event_config of a connector profile.
A comma-separated list of additional fields to expand. Supported values: provider_events (the per-provider event configuration). These are returned as null unless requested.
The https URL events are delivered to. localhost and numeric IP addresses are rejected, and a hostname that does not resolve in DNS fails the request with a 502.
The per-provider event configuration, keyed by provider key and then by unified event name. programmatic and manual provider events the connector does not support are ignored.
The per-provider event configuration, keyed by provider key and then by unified event name. Only resolved when expand=provider_events is requested; null otherwise.
The secret used to sign webhook payloads, for signature verification; null when none is stored.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Stackone","colors":{"primary":"#068F56","light":"#00AF66","dark":"#068F56"},"logo":{"light":"https://mintcdn.com/stackone-60/WsmKpuoeBZmio9QO/images/logo/logo-light-mode.svg?fit=max\u0026auto=format\u0026n=WsmKpuoeBZmio9QO\u0026q=85\u0026s=f08be9c0a142cb1e7fcaa23910c4bf7f","dark":"https://mintcdn.com/stackone-60/WsmKpuoeBZmio9QO/images/logo/logo-dark-mode.svg?fit=max\u0026auto=format\u0026n=WsmKpuoeBZmio9QO\u0026q=85\u0026s=b57d63594c13dee65c06a2d578927466"},"favicon":"https://mintcdn.com/stackone-60/EZ7nWzE-JJzhmP-C/images/logo/favicon.png?fit=max\u0026auto=format\u0026n=EZ7nWzE-JJzhmP-C\u0026q=85\u0026s=9012a8ae6ce9a80698406b611be47925","appearance":{"default":"light"},"background":{"image":{"light":"https://mintcdn.com/stackone-60/knwbcGlYFJSeLObv/images/background/light.svg?fit=max\u0026auto=format\u0026n=knwbcGlYFJSeLObv\u0026q=85\u0026s=112166d244e990ebc0146ff96958757c","dark":"https://mintcdn.com/stackone-60/knwbcGlYFJSeLObv/images/background/dark.svg?fit=max\u0026auto=format\u0026n=knwbcGlYFJSeLObv\u0026q=85\u0026s=50ec5e23eeb91f55e78a0da97dcaeb7b"},"color":{"dark":"#1a1a1a"}},"navbar":{"links":[{"icon":"circle-question","href":"/support","label":"Support"},{"href":"https://app.stackone.com","label":"Login"},{"href":"https://www.stackone.com/demo","label":"Book a demo"}],"primary":{"type":"button","label":"Start Free","href":"https://www.stackone.com/request-free-access"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/stackonehq","twitter":"https://twitter.com/StackOneHQ"}},"seo":{"metatags":{"canonical":"https://docs.stackone.com","google-site-verification":"gYj1x4gkdSwpCGVLFVXNVOPQ_wVrePW37ZKJt3HEqys"}},"fonts":{"heading":{"family":"Sf Pro Display","source":"https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7W0Q5nw.woff2","format":"woff2"},"body":{"family":"Inter","source":"https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7W0Q5nw.woff2","format":"woff2"}},"styling":{"eyebrows":"breadcrumbs","latex":true},"integrations":{"gtm":{"tagId":"GTM-NZNK37TL"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"stackone-60","hasAudioNarration":false,"actualSubdomain":"stackone-60","customDomains":["docs.stackone.com"],"gitSource":{"type":"github","owner":"stackonehq","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae97b0e866f88edeb056ec7","collectionId":"c6de56b0-ae79-4784-a31e-4f46aa6d11ab","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae97b0e866f88edeb056ec7"},"feedback":{"thumbs":true,"edits":false,"issues":false,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae97b0e866f88edeb056ec7","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Connectors","count":9434},{"language":"default","tag":"Embed","count":84},{"language":"default","tag":"Platform API","count":62},{"language":"default","tag":"Gateway","count":49},{"language":"default","tag":"Features","count":48},{"language":"default","tag":"Connector Building","count":42},{"language":"default","tag":"Unified Actions","count":39},{"language":"default","tag":"Embed StackOne","count":36},{"language":"default","tag":"Call Actions","count":29},{"language":"default","tag":"Endpoints","count":25}],"searchSettings":{"isFiltersEnabled":true}},"assistantConfig":{"enableStarterQuestions":false,"deflection":{"enabled":true,"email":"support@stackone.com"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"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":"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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","href":"/_mintlify/custom/stackone-60/e5c931b6e8140842/style.css"}],"page":{"pagePath":"platform/api-reference/v2/webhooks/create-a-webhook","slug":"/platform/api-reference/v2/webhooks/create-a-webhook","pageMetadata":{"openapi":"post /v2/webhooks","title":"Create a webhook","description":"Registers a webhook endpoint in the project and returns it with the signing secret used to verify payload signatures. The webhook receives the events listed in `events`. Connector events are subscribed separately: add the webhook `id` to `webhook_ids` in the `event_config` of a connector profile.","href":"/platform/api-reference/v2/webhooks/create-a-webhook"},"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: [\"Registers a webhook endpoint in the project and returns it with the signing secret used to verify payload signatures. The webhook receives the events listed in \", _jsx(_components.code, {\n children: \"events\"\n }), \". Connector events are subscribed separately: add the webhook \", _jsx(_components.code, {\n children: \"id\"\n }), \" to \", _jsx(_components.code, {\n children: \"webhook_ids\"\n }), \" in the \", _jsx(_components.code, {\n children: \"event_config\"\n }), \" of a connector profile.\"]\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":{"openapi":"post /v2/webhooks","title":"Create a webhook","description":"Registers a webhook endpoint in the project and returns it with the signing secret used to verify payload signatures. The webhook receives the events listed in `events`. Connector events are subscribed separately: add the webhook `id` to `webhook_ids` in the `event_config` of a connector profile.","href":"/platform/api-reference/v2/webhooks/create-a-webhook"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/stackone-60/072d59ca3ea476f6/status-indicator.js","/_mintlify/custom/stackone-60/2cef6058362559bc/connectors.js","/_mintlify/custom/stackone-60/af28b3fbb0435529/hubspot-form.js","/_mintlify/custom/stackone-60/ec01e4530a66d850/end-users.js"],"openApiReferenceData":{"operation":{"description":"Registers a webhook endpoint in the project and returns it with the signing secret used to verify payload signatures. The webhook receives the events listed in `events`. Connector events are subscribed separately: add the webhook `id` to `webhook_ids` in the `event_config` of a connector profile.","operationId":"create_webhook","parameters":["6298cb57-ba67-4e7e-a65d-282d4e090de8"],"requestBody":"3afbced7-eee5-4f61-855c-381994cf4b29","responses":{"201":"8bd97120-2841-401c-b4bb-b172271019d0","400":"74917b9d-678f-41c7-badf-2231eca3a841","401":"cbe92197-b32c-4b25-b1e9-fcad2ba1a9d9","403":"43572c05-414a-4d02-a124-6727bd026ba6","404":"e564e402-050f-4046-85bb-923d1694f435","408":"e7a94de5-839c-4c37-8387-d281f8d8b6de","409":"23f1de69-9ef0-48b0-a605-a6c0ae90f3f7","422":"d33877f0-7559-44ef-bd59-507ccb1a9974","429":"0eb872a6-a016-4a18-9380-4dbedacae335","500":"13199012-7108-443c-9976-863187b90b3a","501":"c9e8d8b6-cda2-4fb0-84e1-a159aeae6406","502":"bf8e0903-138f-4717-a84b-ae72809bbe82"},"security":["7e69e41f-a2d4-4587-88e8-f662a1c711f8"],"summary":"Create a webhook","tags":["Webhooks"],"method":"post","type":"path","servers":["07a3a722-79b2-4d46-beb1-e5729f7528f2"],"path":"/v2/webhooks","baseUrlOptions":["https://api.stackone.com"],"title":"Create a webhook","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6298cb57-ba67-4e7e-a65d-282d4e090de8":{"name":"expand","required":false,"in":"query","description":"A comma-separated list of additional fields to expand. Supported values: `provider_events` (the per-provider event configuration). These are returned as `null` unless requested.","schema":{"oneOf":[{"example":"provider_events","type":"string","description":"A comma-separated list of additional fields to expand. Supported values: `provider_events` (the per-provider event configuration). These are returned as `null` unless requested.","uniqueKey":"oneOf.0","typeLabel":"string"},{"example":"provider_events","type":"null","description":"A comma-separated list of additional fields to expand. Supported values: `provider_events` (the per-provider event configuration). These are returned as `null` unless requested.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"webhook_url":{"type":"string","description":"The https URL events are delivered to. `localhost` and numeric IP addresses are rejected, and a hostname that does not resolve in DNS fails the request with a 502.","example":"https://example.com/stackone/webhooks","isRequired":true,"uniqueKey":"webhook_url","typeLabel":"string"},"events":{"type":"array","example":["account.created","account.updated","account.deleted"],"description":"The events the webhook is subscribed to. Send an empty list for a webhook that only receives connector events routed to it from a connector profile.","items":{"type":"string","description":"A unified webhook event type.","enum":["account.created","account.updated","account.deleted","hris_employees.created","hris_employees.updated","hris_employees.deleted","hris_employments.created","hris_employments.updated","hris_employments.deleted","hris_time_off.created","hris_time_off.updated","hris_time_off.deleted","hris_tasks.created","hris_tasks.updated","hris_tasks.deleted","hris_shifts.created","hris_shifts.updated","hris_shifts.deleted","ats_assessments.created","ats_background_checks.created","ats_candidates.created","ats_candidates.updated","ats_candidates.deleted","ats_applications.created","ats_applications.updated","ats_applications.deleted","ats_interviews.created","ats_interviews.updated","ats_interviews.deleted","ats_jobs.created","ats_jobs.updated","ats_jobs.deleted","ats_job_postings.created","ats_job_postings.updated","ats_job_postings.deleted","ats_users.created","ats_users.updated","ats_users.deleted","ats_lists.created","ats_lists.updated","ats_lists.deleted","crm_contacts.created","crm_contacts.updated","crm_contacts.deleted","crm_accounts.created","crm_accounts.updated","crm_accounts.deleted","lms_completions.created","lms_completions.updated","lms_completions.deleted","lms_content.created","lms_content.updated","lms_content.deleted","lms_assignments.created","lms_assignments.updated","lms_assignments.deleted","lms_courses.created","lms_courses.updated","lms_courses.deleted","lms_users.created","lms_users.updated","lms_users.deleted","documents_files.created","documents_files.updated","documents_files.deleted","documents_folders.created","documents_folders.updated","documents_folders.deleted","documents_drives.created","documents_drives.updated","documents_drives.deleted","screening_results.created","screening_results.updated","screening_results.deleted"],"uniqueKey":"events.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"events","typeLabel":"enum\u003cstring>[]"},"label":{"oneOf":[{"type":"string","description":"A display label for the webhook.","default":"webhook","example":"Production","uniqueKey":"label.oneOf.0","typeLabel":"string"},{"type":"null","description":"A display label for the webhook.","default":"webhook","example":"Production","uniqueKey":"label.oneOf.1","typeLabel":"null"}],"uniqueKey":"label","typeLabel":"string | null"},"provider_events":{"oneOf":[{"type":"object","additionalProperties":{"type":"object","description":"The unified events sourced from the provider, keyed by unified event name.","additionalProperties":{"type":"object","properties":{"synthetic":{"oneOf":[{"type":"object","description":"The StackOne-synthesised source of the event, when the provider has one.","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the event is enabled.","isRequired":true,"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.synthetic.oneOf.0.enabled","typeLabel":"boolean"}},"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.synthetic.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.synthetic.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.synthetic","typeLabel":"object | null"},"programmatic":{"oneOf":[{"type":"object","description":"The provider events wired up programmatically by StackOne.","required":["events"],"properties":{"events":{"type":"object","additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the event is enabled.","isRequired":true,"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.programmatic.oneOf.0.events.additionalProperties.enabled","typeLabel":"boolean"}},"required":["enabled"],"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.programmatic.oneOf.0.events.additionalProperties","typeLabel":"object"},"description":"The provider-specific events of this source, keyed by provider event.","isRequired":true,"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.programmatic.oneOf.0.events","typeLabel":"object"}},"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.programmatic.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.programmatic.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.programmatic","typeLabel":"object | null"},"manual":{"oneOf":[{"type":"object","description":"The provider events requiring manual setup in the external system.","required":["events"],"properties":{"events":{"type":"object","additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the event is enabled.","isRequired":true,"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.manual.oneOf.0.events.additionalProperties.enabled","typeLabel":"boolean"}},"required":["enabled"],"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.manual.oneOf.0.events.additionalProperties","typeLabel":"object"},"description":"The provider-specific events of this source, keyed by provider event.","isRequired":true,"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.manual.oneOf.0.events","typeLabel":"object"}},"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.manual.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.manual.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.manual","typeLabel":"object | null"}},"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties","typeLabel":"object"},"uniqueKey":"provider_events.oneOf.0.additionalProperties","typeLabel":"object"},"description":"The per-provider event configuration, keyed by provider key and then by unified event name. `programmatic` and `manual` provider events the connector does not support are ignored.","uniqueKey":"provider_events.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"object","description":"The unified events sourced from the provider, keyed by unified event name.","additionalProperties":{"type":"object","properties":{"synthetic":{"oneOf":[{"type":"object","description":"The StackOne-synthesised source of the event, when the provider has one.","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the event is enabled.","uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.synthetic.oneOf.0.enabled","typeLabel":"boolean"}},"uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.synthetic.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.synthetic.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.synthetic","typeLabel":"object | null"},"programmatic":{"oneOf":[{"type":"object","description":"The provider events wired up programmatically by StackOne.","required":["events"],"properties":{"events":{"type":"object","additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the event is enabled.","uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.programmatic.oneOf.0.events.additionalProperties.enabled","typeLabel":"boolean"}},"required":["enabled"],"uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.programmatic.oneOf.0.events.additionalProperties","typeLabel":"object"},"description":"The provider-specific events of this source, keyed by provider event.","uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.programmatic.oneOf.0.events","typeLabel":"object"}},"uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.programmatic.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.programmatic.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.programmatic","typeLabel":"object | null"},"manual":{"oneOf":[{"type":"object","description":"The provider events requiring manual setup in the external system.","required":["events"],"properties":{"events":{"type":"object","additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the event is enabled.","uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.manual.oneOf.0.events.additionalProperties.enabled","typeLabel":"boolean"}},"required":["enabled"],"uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.manual.oneOf.0.events.additionalProperties","typeLabel":"object"},"description":"The provider-specific events of this source, keyed by provider event.","uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.manual.oneOf.0.events","typeLabel":"object"}},"uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.manual.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.manual.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.manual","typeLabel":"object | null"}},"uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties","typeLabel":"object"},"uniqueKey":"provider_events.oneOf.1.additionalProperties","typeLabel":"object"},"description":"The per-provider event configuration, keyed by provider key and then by unified event name. `programmatic` and `manual` provider events the connector does not support are ignored.","uniqueKey":"provider_events.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_events","typeLabel":"object | null"}},"required":["webhook_url","events"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"webhook_url":"https://example.com/stackone/webhooks","events":["account.created","account.updated","account.deleted"],"label":"Production","provider_events":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8bd97120-2841-401c-b4bb-b172271019d0":{"description":"The webhook was created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the webhook.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"label":{"type":"string","description":"The display label of the webhook.","isRequired":true,"uniqueKey":"label","typeLabel":"string"},"webhook_url":{"type":"string","description":"The URL webhook events are delivered to.","isRequired":true,"uniqueKey":"webhook_url","typeLabel":"string"},"events":{"description":"The unified event names the webhook is subscribed to (e.g. `employee.created`).","type":"array","items":{"type":"string","uniqueKey":"events.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"events","typeLabel":"string[]"},"status":{"type":"string","description":"The status of the webhook.","enum":["active","inactive","suspended","archived","expired","error","unmapped_value",null],"x-speakeasy-unknown-values":"allow","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"status_reasons":{"description":"The reasons explaining the current status; empty when none are recorded.","type":"array","items":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"When this reason was recorded.","isRequired":true,"uniqueKey":"status_reasons.items.[INDEX].timestamp","typeLabel":"string\u003cdate-time>"},"code":{"oneOf":[{"type":"string","description":"A machine-readable status code.","uniqueKey":"status_reasons.items.[INDEX].code.oneOf.0","typeLabel":"string"},{"type":"null","description":"A machine-readable status code.","uniqueKey":"status_reasons.items.[INDEX].code.oneOf.1","typeLabel":"null"}],"uniqueKey":"status_reasons.items.[INDEX].code","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"A human-readable explanation of the status.","uniqueKey":"status_reasons.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"A human-readable explanation of the status.","uniqueKey":"status_reasons.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"status_reasons.items.[INDEX].description","typeLabel":"string | null"}},"required":["timestamp"],"uniqueKey":"status_reasons.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"status_reasons","typeLabel":"object[]"},"provider_events":{"oneOf":[{"type":"object","additionalProperties":{"type":"object","description":"The unified events sourced from the provider, keyed by unified event name.","additionalProperties":{"type":"object","properties":{"synthetic":{"oneOf":[{"type":"object","description":"The StackOne-synthesised source of the event, when the provider has one.","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the event is enabled.","isRequired":true,"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.synthetic.oneOf.0.enabled","typeLabel":"boolean"}},"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.synthetic.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.synthetic.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.synthetic","typeLabel":"object | null"},"programmatic":{"oneOf":[{"type":"object","description":"The provider events wired up programmatically by StackOne.","required":["events"],"properties":{"events":{"type":"object","additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the event is enabled.","isRequired":true,"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.programmatic.oneOf.0.events.additionalProperties.enabled","typeLabel":"boolean"}},"required":["enabled"],"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.programmatic.oneOf.0.events.additionalProperties","typeLabel":"object"},"description":"The provider-specific events of this source, keyed by provider event.","isRequired":true,"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.programmatic.oneOf.0.events","typeLabel":"object"}},"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.programmatic.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.programmatic.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.programmatic","typeLabel":"object | null"},"manual":{"oneOf":[{"type":"object","description":"The provider events requiring manual setup in the external system.","required":["events"],"properties":{"events":{"type":"object","additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the event is enabled.","isRequired":true,"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.manual.oneOf.0.events.additionalProperties.enabled","typeLabel":"boolean"}},"required":["enabled"],"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.manual.oneOf.0.events.additionalProperties","typeLabel":"object"},"description":"The provider-specific events of this source, keyed by provider event.","isRequired":true,"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.manual.oneOf.0.events","typeLabel":"object"}},"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.manual.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.manual.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties.manual","typeLabel":"object | null"}},"uniqueKey":"provider_events.oneOf.0.additionalProperties.additionalProperties","typeLabel":"object"},"uniqueKey":"provider_events.oneOf.0.additionalProperties","typeLabel":"object"},"description":"The per-provider event configuration, keyed by provider key and then by unified event name. Only resolved when `expand=provider_events` is requested; `null` otherwise.","isRequired":true,"uniqueKey":"provider_events.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"object","description":"The unified events sourced from the provider, keyed by unified event name.","additionalProperties":{"type":"object","properties":{"synthetic":{"oneOf":[{"type":"object","description":"The StackOne-synthesised source of the event, when the provider has one.","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the event is enabled.","uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.synthetic.oneOf.0.enabled","typeLabel":"boolean"}},"uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.synthetic.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.synthetic.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.synthetic","typeLabel":"object | null"},"programmatic":{"oneOf":[{"type":"object","description":"The provider events wired up programmatically by StackOne.","required":["events"],"properties":{"events":{"type":"object","additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the event is enabled.","uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.programmatic.oneOf.0.events.additionalProperties.enabled","typeLabel":"boolean"}},"required":["enabled"],"uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.programmatic.oneOf.0.events.additionalProperties","typeLabel":"object"},"description":"The provider-specific events of this source, keyed by provider event.","uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.programmatic.oneOf.0.events","typeLabel":"object"}},"uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.programmatic.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.programmatic.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.programmatic","typeLabel":"object | null"},"manual":{"oneOf":[{"type":"object","description":"The provider events requiring manual setup in the external system.","required":["events"],"properties":{"events":{"type":"object","additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the event is enabled.","uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.manual.oneOf.0.events.additionalProperties.enabled","typeLabel":"boolean"}},"required":["enabled"],"uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.manual.oneOf.0.events.additionalProperties","typeLabel":"object"},"description":"The provider-specific events of this source, keyed by provider event.","uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.manual.oneOf.0.events","typeLabel":"object"}},"uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.manual.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.manual.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties.manual","typeLabel":"object | null"}},"uniqueKey":"provider_events.oneOf.1.additionalProperties.additionalProperties","typeLabel":"object"},"uniqueKey":"provider_events.oneOf.1.additionalProperties","typeLabel":"object"},"description":"The per-provider event configuration, keyed by provider key and then by unified event name. Only resolved when `expand=provider_events` is requested; `null` otherwise.","isRequired":true,"uniqueKey":"provider_events.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"provider_events","typeLabel":"object | null"},"created_at":{"type":"string","format":"date-time","description":"When the webhook was created.","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"When the webhook was last updated.","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"signing_secret":{"oneOf":[{"type":"string","description":"The secret used to sign webhook payloads, for signature verification; `null` when none is stored.","isRequired":true,"uniqueKey":"signing_secret.oneOf.0","typeLabel":"string"},{"type":"null","description":"The secret used to sign webhook payloads, for signature verification; `null` when none is stored.","isRequired":true,"uniqueKey":"signing_secret.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"signing_secret","typeLabel":"string | null"}},"required":["id","label","webhook_url","events","status","status_reasons","provider_events","created_at","updated_at","signing_secret"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","label":"\u003cstring>","webhook_url":"\u003cstring>","events":["\u003cstring>"],"status":"active","status_reasons":[{"timestamp":"2023-11-07T05:31:56Z","code":"\u003cstring>","description":"\u003cstring>"}],"provider_events":{},"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","signing_secret":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"74917b9d-678f-41c7-badf-2231eca3a841":{"description":"Invalid request.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Bad Request","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"data":{"oneOf":[{"type":"object","description":"Error details","properties":{"statusCode":{"oneOf":[{"type":"number","description":"HTTP status code","example":400,"uniqueKey":"data.oneOf.0.statusCode.oneOf.0","typeLabel":"number"},{"type":"null","description":"HTTP status code","example":400,"uniqueKey":"data.oneOf.0.statusCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.statusCode","typeLabel":"number | null"},"message":{"oneOf":[{"type":"string","description":"Error message","example":"Bad Request","uniqueKey":"data.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Error message","example":"Bad Request","uniqueKey":"data.oneOf.0.message.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.message","typeLabel":"string | null"},"headers":{"oneOf":[{"type":"object","description":"Response headers","example":{"content-type":"application/json","x-request-id":"5678c28b211dace4e0a0f9171e6b88c5"},"uniqueKey":"data.oneOf.0.headers.oneOf.0","typeLabel":"object"},{"type":"null","description":"Response headers","example":{"content-type":"application/json","x-request-id":"5678c28b211dace4e0a0f9171e6b88c5"},"uniqueKey":"data.oneOf.0.headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.headers","typeLabel":"object | null"}},"uniqueKey":"data.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"object | null"},"provider_errors":{"oneOf":[{"description":"List of provider-specific errors","type":"array","items":{"type":"object","properties":{"status":{"oneOf":[{"type":"number","description":"HTTP status code of the provider error","example":400,"uniqueKey":"provider_errors.oneOf.0.items.[INDEX].status.oneOf.0","typeLabel":"number"},{"type":"null","description":"HTTP status code of the provider error","example":400,"uniqueKey":"provider_errors.oneOf.0.items.[INDEX].status.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_errors.oneOf.0.items.[INDEX].status","typeLabel":"number | null"},"url":{"oneOf":[{"type":"string","description":"URL that caused the error","example":"https://api.provider.com/v1/resource","uniqueKey":"provider_errors.oneOf.0.items.[INDEX].url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL that caused the error","example":"https://api.provider.com/v1/resource","uniqueKey":"provider_errors.oneOf.0.items.[INDEX].url.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_errors.oneOf.0.items.[INDEX].url","typeLabel":"string | null"},"raw":{"oneOf":[{"type":"object","description":"Raw error response from the provider","example":{"message":"Invalid input parameters"},"uniqueKey":"provider_errors.oneOf.0.items.[INDEX].raw.oneOf.0","typeLabel":"object"},{"type":"null","description":"Raw error response from the provider","example":{"message":"Invalid input parameters"},"uniqueKey":"provider_errors.oneOf.0.items.[INDEX].raw.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_errors.oneOf.0.items.[INDEX].raw","typeLabel":"object | null"},"headers":{"oneOf":[{"type":"object","description":"Response headers","example":{"content-type":"application/json","x-request-id":"5678c28b211dace4e0a0f9171e6b88c5"},"uniqueKey":"provider_errors.oneOf.0.items.[INDEX].headers.oneOf.0","typeLabel":"object"},{"type":"null","description":"Response headers","example":{"content-type":"application/json","x-request-id":"5678c28b211dace4e0a0f9171e6b88c5"},"uniqueKey":"provider_errors.oneOf.0.items.[INDEX].headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_errors.oneOf.0.items.[INDEX].headers","typeLabel":"object | null"}},"uniqueKey":"provider_errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"provider_errors.oneOf.0","typeLabel":"object[]"},{"description":"List of provider-specific errors","type":"null","items":{"type":"object","properties":{"status":{"oneOf":[{"type":"number","description":"HTTP status code of the provider error","example":400},{"type":"null","description":"HTTP status code of the provider error","example":400}]},"url":{"oneOf":[{"type":"string","description":"URL that caused the error","example":"https://api.provider.com/v1/resource"},{"type":"null","description":"URL that caused the error","example":"https://api.provider.com/v1/resource"}]},"raw":{"oneOf":[{"type":"object","description":"Raw error response from the provider","example":{"message":"Invalid input parameters"}},{"type":"null","description":"Raw error response from the provider","example":{"message":"Invalid input parameters"}}]},"headers":{"oneOf":[{"type":"object","description":"Response headers","example":{"content-type":"application/json","x-request-id":"5678c28b211dace4e0a0f9171e6b88c5"}},{"type":"null","description":"Response headers","example":{"content-type":"application/json","x-request-id":"5678c28b211dace4e0a0f9171e6b88c5"}}]}}},"uniqueKey":"provider_errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_errors","typeLabel":"object[] | null"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"message":"Bad Request","timestamp":"2023-05-30T00:00:00.000Z","data":{"statusCode":400,"message":"Bad Request","headers":{"content-type":"application/json","x-request-id":"5678c28b211dace4e0a0f9171e6b88c5"}},"provider_errors":[{"status":400,"url":"https://api.provider.com/v1/resource","raw":{"message":"Invalid input parameters"},"headers":{"content-type":"application/json","x-request-id":"5678c28b211dace4e0a0f9171e6b88c5"}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"cbe92197-b32c-4b25-b1e9-fcad2ba1a9d9":{"description":"Unauthorized access.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":401,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Unauthorized","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":401,"message":"Unauthorized","timestamp":"2023-05-30T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"43572c05-414a-4d02-a124-6727bd026ba6":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":403,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Forbidden resource","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":403,"message":"Forbidden resource","timestamp":"2023-05-30T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"e564e402-050f-4046-85bb-923d1694f435":{"description":"Resource not found.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Not Found","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"message":"Not Found","timestamp":"2023-05-30T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"e7a94de5-839c-4c37-8387-d281f8d8b6de":{"description":"The request has timed out.","headers":{"Retry-After":{"description":"A time in seconds after which the request can be retried.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":408,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Request timed out","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":408,"message":"Request timed out","timestamp":"2023-05-30T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"23f1de69-9ef0-48b0-a605-a6c0ae90f3f7":{"description":"Conflict with current state.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":409,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Conflict","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":409,"message":"Conflict","timestamp":"2023-05-30T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"d33877f0-7559-44ef-bd59-507ccb1a9974":{"description":"Validation error.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":422,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Unprocessable Entity","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":422,"message":"Unprocessable Entity","timestamp":"2023-05-30T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"0eb872a6-a016-4a18-9380-4dbedacae335":{"description":"Too many requests.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":429,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Too many requests","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":429,"message":"Too many requests","timestamp":"2023-05-30T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"13199012-7108-443c-9976-863187b90b3a":{"description":"Server error while executing the request.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":500,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Internal server error","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":500,"message":"Internal server error","timestamp":"2023-05-30T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"c9e8d8b6-cda2-4fb0-84e1-a159aeae6406":{"description":"This functionality is not implemented.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":501,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Not Implemented","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":501,"message":"Not Implemented","timestamp":"2023-05-30T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"bf8e0903-138f-4717-a84b-ae72809bbe82":{"description":"Bad gateway error.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":502,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Bad Gateway","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":502,"message":"Bad Gateway","timestamp":"2023-05-30T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"7e69e41f-a2d4-4587-88e8-f662a1c711f8":{"basic":{"type":"http","scheme":"basic","scopes":[],"schemeName":"basic"}}},"servers":{"07a3a722-79b2-4d46-beb1-e5729f7528f2":{"url":"https://api.stackone.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","scopes":[],"schemeName":"basic"},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"basic","name":"Authorization"}],"title":"basic"}]},"originalFileLocation":"platform/api-reference/platform-v2.json"},"subdomain":"stackone-60","siteName":"Stackone","title":"Create a webhook - Stackone","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-15T17:48:40.580Z","originalFileLocation":"platform/api-reference/v2/webhooks/create-a-webhook.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}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 webhook endpoint in the project and returns it with the signing secret used to verify payload signatures. The webhook receives the events listed in events. Connector events are subscribed separately: add the webhook id to webhook_ids in the event_config of a connector profile.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Stackone\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/stackone-60/vUkZo0TYnLvO23Z1/_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/stackone-60/vUkZo0TYnLvO23Z1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/stackone-60/vUkZo0TYnLvO23Z1/_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/stackone-60/vUkZo0TYnLvO23Z1/_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/stackone-60/vUkZo0TYnLvO23Z1/_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/stackone-60/vUkZo0TYnLvO23Z1/_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/stackone-60/vUkZo0TYnLvO23Z1/_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/stackone-60/vUkZo0TYnLvO23Z1/_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/stackone-60/vUkZo0TYnLvO23Z1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a webhook - Stackone\">\u003cmeta data-mint-head property=\"og:description\" content=\"Registers a webhook endpoint in the project and returns it with the signing secret used to verify payload signatures. The webhook receives the events listed in events. Connector events are subscribed separately: add the webhook id to webhook_ids in the event_config of a connector profile.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Stackone\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.stackone.com/platform/api-reference/v2/webhooks/create-a-webhook\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://stackone-60.mintlify.app/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Create+a+webhook\u0026amp;description=Registers+a+webhook+endpoint+in+the+project+and+returns+it+with+the+signing+secret+used+to+verify+payload+signatures.+The+webhook+receives+the+events+listed+in+\u0026amp;theme=841e834217e7bb36731c6d12\u0026amp;signature=3cacc250e94da1ff405297f914f8725048e9deba5e7247c664306cc282ac68d4\">\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=\"Create a webhook - Stackone\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Registers a webhook endpoint in the project and returns it with the signing secret used to verify payload signatures. The webhook receives the events listed in events. Connector events are subscribed separately: add the webhook id to webhook_ids in the event_config of a connector profile.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://stackone-60.mintlify.app/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Create+a+webhook\u0026amp;description=Registers+a+webhook+endpoint+in+the+project+and+returns+it+with+the+signing+secret+used+to+verify+payload+signatures.+The+webhook+receives+the+events+listed+in+\u0026amp;theme=841e834217e7bb36731c6d12\u0026amp;signature=3cacc250e94da1ff405297f914f8725048e9deba5e7247c664306cc282ac68d4\">\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/stackone-60/vUkZo0TYnLvO23Z1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Stackone\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#068F56\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"gYj1x4gkdSwpCGVLFVXNVOPQ_wVrePW37ZKJt3HEqys\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.stackone.com/platform/api-reference/v2/webhooks/create-a-webhook\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/platform/api-reference/v2/webhooks/create-a-webhook.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.stackone.com/#organization\",\"name\":\"Stackone\",\"url\":\"https://docs.stackone.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/stackone-60/WsmKpuoeBZmio9QO/images/logo/logo-light-mode.svg?fit=max\u0026auto=format\u0026n=WsmKpuoeBZmio9QO\u0026q=85\u0026s=f08be9c0a142cb1e7fcaa23910c4bf7f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.stackone.com#website\",\"name\":\"Stackone\",\"url\":\"https://docs.stackone.com\",\"publisher\":{\"@id\":\"https://docs.stackone.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.stackone.com/platform/api-reference/v2/webhooks/create-a-webhook#webpage\",\"url\":\"https://docs.stackone.com/platform/api-reference/v2/webhooks/create-a-webhook\",\"name\":\"Create a webhook\",\"description\":\"Registers a webhook endpoint in the project and returns it with the signing secret used to verify payload signatures. The webhook receives the events listed in events. Connector events are subscribed separately: add the webhook id to webhook_ids in the event_config of a connector profile.\",\"dateModified\":\"2026-10-15T17:48:40.580Z\",\"isPartOf\":{\"@id\":\"https://docs.stackone.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.stackone.com/platform/api-reference/v2/webhooks/create-a-webhook#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.stackone.com/platform/api-reference/v2/webhooks/create-a-webhook#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Webhooks\",\"item\":\"https://docs.stackone.com/platform/api-reference/v2/webhooks/list-webhooks\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a webhook\",\"item\":\"https://docs.stackone.com/platform/api-reference/v2/webhooks/create-a-webhook\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.stackone.com/platform/api-reference/v2/webhooks/create-a-webhook#apireference\",\"headline\":\"Create a webhook\",\"name\":\"Create a webhook\",\"description\":\"Registers a webhook endpoint in the project and returns it with the signing secret used to verify payload signatures. The webhook receives the events listed in events. Connector events are subscribed separately: add the webhook id to webhook_ids in the event_config of a connector profile.\",\"url\":\"https://docs.stackone.com/platform/api-reference/v2/webhooks/create-a-webhook\",\"mainEntityOfPage\":{\"@id\":\"https://docs.stackone.com/platform/api-reference/v2/webhooks/create-a-webhook#webpage\"},\"dateModified\":\"2026-10-15T17:48:40.580Z\",\"publisher\":{\"@id\":\"https://docs.stackone.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.stackone.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Stackone\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Stackone","nav":{"global":null,"tabs":[{"tab":"Gateway","icon":"rocket","pages":[{"title":"Gateway","href":"/end-users/overview"}]},{"tab":"Connectors","icon":"plug","pages":[{"title":"Connectors","href":"/connectors/introduction"}]},{"tab":"Embed","icon":"cube","pages":[{"title":"Embed","href":"/embed/overview"}]},{"tab":"Platform API","icon":"code","groups":[{"group":"Overview","root":{"title":"Platform API Reference","href":"/platform-api/overview"},"expanded":true,"pages":[{"title":"Authentication","sidebarTitle":"Authentication","href":"/platform-api/authentication"},{"group":"Request Parameters","pages":[{"title":"Pagination","href":"/platform-api/request-parameters/pagination"},{"title":"Filtering","href":"/platform-api/request-parameters/filtering"},{"title":"Expanding Fields","href":"/platform-api/request-parameters/expanding-fields"}]},{"title":"Rate Limiting","href":"/platform-api/rate-limiting"},{"title":"Platform Events","sidebarTitle":"Platform Events","href":"/platform-api/platform-events"},{"title":"API SDKs","href":"/platform-api/api-sdks"}]},{"group":"Accounts","icon":"users","expanded":true,"pages":[{"openapi":"get /v2/accounts","title":"List accounts","href":"/platform/api-reference/v2/accounts/list-accounts"},{"openapi":"get /v2/accounts/filters","title":"List account filter values","href":"/platform/api-reference/v2/accounts/list-account-filter-values"},{"openapi":"get /v2/accounts/{id}","title":"Get an account","href":"/platform/api-reference/v2/accounts/get-an-account"},{"openapi":"patch /v2/accounts/{id}","title":"Patch an account","href":"/platform/api-reference/v2/accounts/patch-an-account"},{"openapi":"delete /v2/accounts/{id}","title":"Delete an account","href":"/platform/api-reference/v2/accounts/delete-an-account"}]},{"group":"Actions","icon":"bolt","expanded":true,"pages":[{"openapi":"post /actions/search","title":"Search connector actions by semantic similarity","href":"/platform/api-reference/actions/search-connector-actions-by-semantic-similarity"},{"openapi":"post /actions/rpc","title":"Make an RPC call to an action","href":"/platform/api-reference/actions/make-an-rpc-call-to-an-action"},{"openapi":"post /actions/rpc/synced","title":"Read synced action data from the datasync index","href":"/platform/api-reference/actions/read-synced-action-data-from-the-datasync-index"},{"openapi":"post /actions/rpc/synced/queryable_fields","title":"List the fields a synced action's data can be queried by","href":"/platform/api-reference/actions/list-the-fields-a-synced-actions-data-can-be-queried-by"},{"openapi":"post /unified/check_permissions","title":"Check user permissions on a resource","href":"/platform/api-reference/actions/check-user-permissions-on-a-resource"}]},{"group":"Connect Sessions","icon":"link","expanded":true,"pages":[{"openapi":"post /connect_sessions","title":"Create Connect Session","href":"/platform/api-reference/connect-sessions/create-connect-session"},{"openapi":"get /connect_sessions/{id}","title":"Get Connect Session","href":"/platform/api-reference/connect-sessions/get-connect-session"},{"openapi":"post /connect_sessions/authenticate","title":"Authenticate Connect Session","href":"/platform/api-reference/connect-sessions/authenticate-connect-session"}]},{"group":"Connector Profiles","icon":"sliders","expanded":true,"pages":[{"openapi":"get /v2/connector_profiles","title":"List connector profiles","href":"/platform/api-reference/v2/connector-profiles/list-connector-profiles"},{"openapi":"get /v2/connector_profiles/{id}","title":"Get a connector profile","href":"/platform/api-reference/v2/connector-profiles/get-a-connector-profile"},{"openapi":"post /v2/connector_profiles","title":"Create a connector profile","href":"/platform/api-reference/v2/connector-profiles/create-a-connector-profile"},{"openapi":"patch /v2/connector_profiles/{id}","title":"Patch a connector profile","href":"/platform/api-reference/v2/connector-profiles/patch-a-connector-profile"},{"openapi":"delete /v2/connector_profiles/{id}","title":"Delete a connector profile","href":"/platform/api-reference/v2/connector-profiles/delete-a-connector-profile"}]},{"group":"Connectors","icon":"puzzle-piece","expanded":true,"pages":[{"openapi":"get /v2/connectors","title":"List connectors","href":"/platform/api-reference/v2/connectors/list-connectors"},{"openapi":"get /v2/connectors/{id}","title":"Get connector","href":"/platform/api-reference/v2/connectors/get-connector"},{"openapi":"get /v2/connectors/{id}/actions/{actionId}","title":"Get connector action","href":"/platform/api-reference/v2/connectors/get-connector-action"},{"openapi":"get /v2/connectors/{id}/event_actions/{eventId}","title":"Get connector event action","href":"/platform/api-reference/v2/connectors/get-connector-event-action"},{"openapi":"get /v2/connectors/{id}/versions","title":"List connector versions","href":"/platform/api-reference/v2/connectors/list-connector-versions"},{"openapi":"post /v2/connectors","title":"Create a connector","href":"/platform/api-reference/v2/connectors/create-a-connector"},{"openapi":"delete /v2/connectors/{id}","title":"Delete a connector","href":"/platform/api-reference/v2/connectors/delete-a-connector"}]},{"group":"Data Sync","icon":"rotate","expanded":true,"pages":[{"group":"Sync Configs","expanded":true,"pages":[{"openapi":"get /v2/data_sync/sync_configs","title":"List sync configs","href":"/platform/api-reference/v2/data-sync/list-sync-configs"},{"openapi":"get /v2/data_sync/sync_configs/{id}","title":"Get a sync config","href":"/platform/api-reference/v2/data-sync/get-a-sync-config"},{"openapi":"get /v2/data_sync/sync_configs/{id}/parameters","title":"Get a sync config action's parameters","href":"/platform/api-reference/v2/data-sync/get-a-sync-config-actions-parameters"},{"openapi":"post /v2/data_sync/sync_configs","title":"Create a sync config","href":"/platform/api-reference/v2/data-sync/create-a-sync-config"},{"openapi":"patch /v2/data_sync/sync_configs/{id}","title":"Patch a sync config","href":"/platform/api-reference/v2/data-sync/patch-a-sync-config"},{"openapi":"delete /v2/data_sync/sync_configs/{id}","title":"Delete a sync config","href":"/platform/api-reference/v2/data-sync/delete-a-sync-config"}]},{"group":"Schedules","expanded":true,"pages":[{"openapi":"get /v2/data_sync/schedules","title":"List schedules","href":"/platform/api-reference/v2/data-sync/list-schedules"},{"openapi":"get /v2/data_sync/schedules/{id}","title":"Get a schedule","href":"/platform/api-reference/v2/data-sync/get-a-schedule"},{"openapi":"patch /v2/data_sync/schedules/{id}","title":"Patch a schedule","href":"/platform/api-reference/v2/data-sync/patch-a-schedule"}]},{"group":"Runs","expanded":true,"pages":[{"openapi":"get /v2/data_sync/runs","title":"List runs","href":"/platform/api-reference/v2/data-sync/list-runs"},{"openapi":"get /v2/data_sync/runs/{id}","title":"Get a run","href":"/platform/api-reference/v2/data-sync/get-a-run"}]}]},{"group":"Logs","icon":"file-lines","expanded":true,"pages":[{"openapi":"post /logs","title":"List Logs","href":"/platform/api-reference/logs/list-logs"},{"openapi":"post /logs/platform","title":"List Platform Logs","href":"/platform/api-reference/logs/list-platform-logs"},{"openapi":"post /logs/provider","title":"List Provider Logs","href":"/platform/api-reference/logs/list-provider-logs"},{"group":"Action Logs","expanded":true,"pages":[{"openapi":"post /logs/actions","title":"List Action Logs","href":"/platform/api-reference/logs/list-action-logs"},{"openapi":"get /logs/actions/{actionRunId}","title":"Get Action Log","href":"/platform/api-reference/logs/get-action-log"},{"openapi":"get /logs/actions/{actionRunId}/advanced","title":"Get Action Advanced Log","href":"/platform/api-reference/logs/get-action-advanced-log"},{"openapi":"get /logs/actions/{actionRunId}/defender","title":"Get Action Defender Log","href":"/platform/api-reference/logs/get-action-defender-log"}]},{"group":"Step Logs","expanded":true,"pages":[{"openapi":"post /logs/steps","title":"List Step Logs","href":"/platform/api-reference/logs/list-step-logs"},{"openapi":"get /logs/actions/{actionRunId}/steps","title":"List Action Step Logs","href":"/platform/api-reference/logs/list-action-step-logs"},{"openapi":"get /logs/actions/{actionRunId}/steps/{stepIndex}","title":"Get Step Log","href":"/platform/api-reference/logs/get-step-log"},{"openapi":"get /logs/actions/{actionRunId}/steps/{stepIndex}/advanced","title":"Get Step Advanced Log","href":"/platform/api-reference/logs/get-step-advanced-log"}]},{"group":"Stats","expanded":true,"pages":[{"openapi":"post /logs/stats/aggregate","title":"Get Logs Stats Aggregate","href":"/platform/api-reference/logs/get-logs-stats-aggregate"},{"openapi":"post /logs/stats/dimensions","title":"Get Logs Stats Dimensions","href":"/platform/api-reference/logs/get-logs-stats-dimensions"}]}]},{"group":"MCP","icon":"plug","expanded":true,"pages":[{"openapi":"post /mcp","title":"Send MCP JSON-RPC message","href":"/platform/api-reference/mcp/send-mcp-json-rpc-message"}]},{"group":"Webhooks","icon":"webhook","expanded":true,"pages":[{"openapi":"get /v2/webhooks","title":"List webhooks","href":"/platform/api-reference/v2/webhooks/list-webhooks"},{"openapi":"get /v2/webhooks/{id}","title":"Get a webhook","description":"Returns the webhook, including the signing secret used to verify payload signatures.","href":"/platform/api-reference/v2/webhooks/get-a-webhook"},{"openapi":"post /v2/webhooks","title":"Create a webhook","href":"/platform/api-reference/v2/webhooks/create-a-webhook"},{"openapi":"patch /v2/webhooks/{id}","title":"Update a webhook","description":"Applies a partial update; omitted fields are left unchanged. Set `status` to `inactive` to pause deliveries without deleting the webhook.","href":"/platform/api-reference/v2/webhooks/update-a-webhook"},{"openapi":"delete /v2/webhooks/{id}","title":"Delete a webhook","href":"/platform/api-reference/v2/webhooks/delete-a-webhook"}]}]}]},"basePath":"","title":"Create a webhook - Stackone","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}