{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Vartiq Docs","colors":{"primary":"#1A1A1A","light":"#E6E6E7","dark":"#1A1A1A"},"logo":{"light":"https://mintcdn.com/vartiq/RaHI3S0p6T4OPVWe/logo/light.svg?fit=max\u0026auto=format\u0026n=RaHI3S0p6T4OPVWe\u0026q=85\u0026s=176d03edd48a11f900335f104fa5a5ab","dark":"https://mintcdn.com/vartiq/RaHI3S0p6T4OPVWe/logo/dark.svg?fit=max\u0026auto=format\u0026n=RaHI3S0p6T4OPVWe\u0026q=85\u0026s=9d6d47e6e8363b35d61c30f0ace8595d"},"favicon":"/favicon.ico","api":{"mdx":{"auth":{"method":"key","name":"x-api-key"},"server":"https://api.us.vartiq.com"}},"navbar":{"links":[{"label":"Support","href":"mailto:support@vartiq.com"}],"primary":{"type":"button","label":"Console","href":"https://console.vartiq.com"}},"footer":{"socials":{"x":"https://x.com/VartiqHQ","github":"https://github.com/vartiqhq","linkedin":"https://linkedin.com/company/vartiqhq","slack":"https://join.slack.com/t/vartiqcommunity/shared_invite/zt-3bi32f9ok-1~brfzsYhPtEgSn_y4SWgQ"}},"seo":{"metatags":{"google-site-verification":"22lkColhdFRi7seZXhlzCnHi_Yz4I1D8TNjN0mhLXkM"},"indexing":"all"},"integrations":{"gtm":{"tagId":"GTM-WGQS6XTL"},"posthog":{"apiKey":"phc_GUSVcDEXWgSEdcloYYL2MNZK4ertauYN8ldwC96vFNd"}},"contextual":{"options":["copy","view","chatgpt","claude"]},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vartiq","hasAudioNarration":false,"actualSubdomain":"vartiq","customDomains":["docs.vartiq.com"],"gitSource":{"type":"github","owner":"vartiqhq","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e6efbd0a90f91cb45561","collectionId":"7cda88fd-4e28-41d7-a967-9727da08e61b","schemaVersion":"v2"},"entitlements":{},"buildId":"6ae9286f84bbcfd4783b3784:success","clientVersion":"0.0.4064","searchFilterCounts":[{"language":"default","tag":"API Reference","count":16},{"language":"default","tag":"Apps","count":5},{"language":"default","tag":"Projects","count":5},{"language":"default","tag":"Webhooks","count":5},{"language":"default","tag":"Usage","count":5},{"language":"default","tag":"Essentials","count":3},{"language":"default","tag":"Get Started","count":2},{"language":"default","tag":"Webhook Messages","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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/webhooks/create-webhook","slug":"/api-reference/webhooks/create-webhook","pageMetadata":{"title":"Create Webhook","api":"POST /webhooks","description":null,"href":"/api-reference/webhooks/create-webhook"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ParamField,ResponseField}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`3`,id:`body-parameters`,children:`Body Parameters`}),`\n`,_jsx(ParamField,{body:`appId`,type:`string`,id:`param-app-id`,children:_jsxs(_components.p,{children:[`The ID of the app to create the webhook for.`,_jsx(`br`,{}),`\nRequired for webhooks in an app. Not required for global webhooks.`]})}),`\n`,_jsx(ParamField,{body:`projectId`,type:`string`,id:`param-project-id`,children:_jsxs(_components.p,{children:[`The ID of the app to create the webhook for.`,_jsx(`br`,{}),`\nRequired for global webhooks.`]})}),`\n`,_jsx(ParamField,{body:`url`,type:`string`,required:true,id:`param-url`,children:_jsx(_components.p,{children:`The URL where webhook events will be sent`})}),`\n`,_jsxs(ParamField,{body:`customHeaders`,type:`array`,id:`param-custom-headers`,children:[_jsx(_components.p,{children:`Array of custom headers to be sent with the webhook`}),_jsxs(Expandable,{title:`Custom Header Object`,children:[_jsx(ParamField,{body:`key`,type:`string`,required:true,id:`param-key`,children:_jsx(_components.p,{children:`Header key`})}),_jsx(ParamField,{body:`value`,type:`string`,required:true,id:`param-value`,children:_jsx(_components.p,{children:`Header value`})})]})]}),`\n`,_jsx(ParamField,{body:`authMethod`,type:`string`,id:`param-auth-method`,children:_jsx(_components.p,{children:`Authentication method for the webhook. Must be one of: “basic”, “hmac”, or “apiKey”`})}),`\n`,_jsx(ParamField,{body:`userName`,type:`string`,id:`param-user-name`,children:_jsx(_components.p,{children:`Username for basic authentication (required if authMethod is “basic”)`})}),`\n`,_jsx(ParamField,{body:`password`,type:`string`,id:`param-password`,children:_jsx(_components.p,{children:`Password for basic authentication (required if authMethod is “basic”)`})}),`\n`,_jsx(ParamField,{body:`apiKey`,type:`string`,id:`param-api-key`,children:_jsx(_components.p,{children:`API key for apiKey authentication (required if authMethod is “apiKey”)`})}),`\n`,_jsx(ParamField,{body:`apiKeyHeader`,type:`string`,id:`param-api-key-header`,children:_jsx(_components.p,{children:`Header name for the API key (required if authMethod is “apiKey”)`})}),`\n`,_jsx(ParamField,{body:`hmacHeader`,type:`string`,id:`param-hmac-header`,children:_jsx(_components.p,{children:`Header name for the HMAC signature (required if authMethod is “hmac”)`})}),`\n`,_jsx(ParamField,{body:`hmacSecret`,type:`string`,id:`param-hmac-secret`,children:_jsx(_components.p,{children:`Secret for HMAC signature generation (required if authMethod is “hmac”)`})}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success`,children:_jsx(_components.p,{children:`Indicates if the request was successful`})}),`\n`,_jsx(ResponseField,{name:`message`,type:`string`,id:`param-message`,children:_jsx(_components.p,{children:`A message describing the result of the operation`})}),`\n`,_jsxs(ResponseField,{name:`data`,type:`object`,id:`param-data`,children:[_jsx(_components.p,{children:`The created webhook object`}),_jsxs(Expandable,{title:`Properties`,children:[_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id`,children:_jsx(_components.p,{children:`Unique identifier for the webhook`})}),_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name`,children:_jsx(_components.p,{children:`Name of the webhook`})}),_jsx(ResponseField,{name:`url`,type:`string`,id:`param-url-1`,children:_jsx(_components.p,{children:`URL where webhook events will be sent`})}),_jsxs(ResponseField,{name:`customHeaders`,type:`array`,id:`param-custom-headers-1`,children:[_jsx(_components.p,{children:`Array of custom headers`}),_jsxs(Expandable,{title:`Header Object`,children:[_jsx(ResponseField,{name:`key`,type:`string`,id:`param-key-1`,children:_jsx(_components.p,{children:`Header key`})}),_jsx(ResponseField,{name:`value`,type:`string`,id:`param-value-1`,children:_jsx(_components.p,{children:`Header value`})})]})]}),_jsxs(ResponseField,{name:`headers`,type:`array`,id:`param-headers`,children:[_jsx(_components.p,{children:`Array of default headers`}),_jsxs(Expandable,{title:`Header Object`,children:[_jsx(ResponseField,{name:`key`,type:`string`,id:`param-key-2`,children:_jsx(_components.p,{children:`Header key`})}),_jsx(ResponseField,{name:`value`,type:`string`,id:`param-value-2`,children:_jsx(_components.p,{children:`Header value`})})]})]}),_jsxs(ResponseField,{name:`authMethod`,type:`object`,id:`param-auth-method-1`,children:[_jsx(_components.p,{children:`Authentication method configuration`}),_jsxs(Expandable,{title:`Properties`,children:[_jsx(ResponseField,{name:`method`,type:`string`,id:`param-method`,children:_jsx(_components.p,{children:`Authentication method type (hmac, api_key, or basic)`})}),_jsx(ResponseField,{name:`hmacHeader`,type:`string`,id:`param-hmac-header-1`,children:_jsx(_components.p,{children:`Custom header name for HMAC signature (if method is hmac)`})}),_jsx(ResponseField,{name:`hmacSecret`,type:`string`,id:`param-hmac-secret-1`,children:_jsx(_components.p,{children:`Secret used for HMAC signature generation (if method is hmac)`})}),_jsx(ResponseField,{name:`apiKey`,type:`string`,id:`param-api-key-1`,children:_jsx(_components.p,{children:`API key value (if method is api_key)`})}),_jsx(ResponseField,{name:`apiKeyHeader`,type:`string`,id:`param-api-key-header-1`,children:_jsx(_components.p,{children:`Custom header name for API key (if method is api_key)`})}),_jsx(ResponseField,{name:`userName`,type:`string`,id:`param-user-name-1`,children:_jsx(_components.p,{children:`Username for basic authentication (if method is basic)`})}),_jsx(ResponseField,{name:`password`,type:`string`,id:`param-password-1`,children:_jsx(_components.p,{children:`Password for basic authentication (if method is basic)`})})]})]}),_jsx(ResponseField,{name:`createdAt`,type:`string`,id:`param-created-at`,children:_jsx(_components.p,{children:`Timestamp when the webhook was created`})}),_jsx(ResponseField,{name:`updatedAt`,type:`string`,id:`param-updated-at`,children:_jsx(_components.p,{children:`Timestamp when the webhook was last updated`})})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`response-example`,children:`Response Example`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`29`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`29`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Webhook created successfully\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"wh_01JT39DVQGKA1RV4QNJ1VFRNW2\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"heelo\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://exp.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"secret\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"01JT39DVQJW3A49TR3XXFVM939\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"customHeaders\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"x-app\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"value\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"x-value\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"headers\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Content-Type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"value\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"application/json\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"authMethod\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"hmacHeader\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"x-Vartiq-signature\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"hmacSecret\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"uPvKnaxMwD1gHs1uFNJh-UEn3D5ha5WZcS3WTMVUExY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"method\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"hmac\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"createdAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2025-04-30T12:06:00.703Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"updatedAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2025-04-30T12:06:00.703Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Webhook","api":"POST /webhooks","description":null,"href":"/api-reference/webhooks/create-webhook"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Body Parameters","slug":"body-parameters","depth":3,"children":[]},{"title":"Response","slug":"response","depth":3,"children":[]},{"title":"Response Example","slug":"response-example","depth":3,"children":[]}],"codeExamples":{},"endpoint":{"title":"Create Webhook","path":"/webhooks","servers":[{"url":"https://api.us.vartiq.com"}],"method":"post","request":{"security":[{"title":"API Key Auth","parameters":{"header":{"x-api-key":{"type":"apiKey"}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"appId":[{"type":"string","description":"The ID of the app to create the webhook for. Required for webhooks in an app. Not required for global webhooks."}],"projectId":[{"type":"string","description":"The ID of the app to create the webhook for. Required for global webhooks."}],"url":[{"type":"string","description":"The URL where webhook events will be sent","required":true}],"customHeaders":[{"type":"array","items":[{"type":"object","properties":{"key":[{"type":"string","description":"Header key","required":true}],"value":[{"type":"string","description":"Header value","required":true}]}}],"description":"Array of custom headers to be sent with the webhook"}],"authMethod":[{"type":"string","description":"Authentication method for the webhook. Must be one of: “basic”, “hmac”, or “apiKey”"}],"userName":[{"type":"string","description":"Username for basic authentication (required if authMethod is “basic”)"}],"password":[{"type":"string","description":"Password for basic authentication (required if authMethod is “basic”)"}],"apiKey":[{"type":"string","description":"API key for apiKey authentication (required if authMethod is “apiKey”)"}],"apiKeyHeader":[{"type":"string","description":"Header name for the API key (required if authMethod is “apiKey”)"}],"hmacHeader":[{"type":"string","description":"Header name for the HMAC signature (required if authMethod is “hmac”)"}],"hmacSecret":[{"type":"string","description":"Secret for HMAC signature generation (required if authMethod is “hmac”)"}]}}],"examples":{"example":{"value":{"appId":"\u003cstring>","projectId":"\u003cstring>","url":"\u003cstring>","customHeaders":[{"key":"\u003cstring>","value":"\u003cstring>"}],"authMethod":"\u003cstring>","userName":"\u003cstring>","password":"\u003cstring>","apiKey":"\u003cstring>","apiKeyHeader":"\u003cstring>","hmacHeader":"\u003cstring>","hmacSecret":"\u003cstring>"}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"success":[{"type":"boolean","description":"Indicates if the request was successful"}],"message":[{"type":"string","description":"A message describing the result of the operation"}],"data":[{"type":"object","properties":{"id":[{"type":"string","description":"Unique identifier for the webhook"}],"name":[{"type":"string","description":"Name of the webhook"}],"url":[{"type":"string","description":"URL where webhook events will be sent"}],"customHeaders":[{"type":"array","items":[{"type":"object","properties":{"key":[{"type":"string","description":"Header key"}],"value":[{"type":"string","description":"Header value"}]}}],"description":"Array of custom headers"}],"headers":[{"type":"array","items":[{"type":"object","properties":{"key":[{"type":"string","description":"Header key"}],"value":[{"type":"string","description":"Header value"}]}}],"description":"Array of default headers"}],"authMethod":[{"type":"object","properties":{"method":[{"type":"string","description":"Authentication method type (hmac, api_key, or basic)"}],"hmacHeader":[{"type":"string","description":"Custom header name for HMAC signature (if method is hmac)"}],"hmacSecret":[{"type":"string","description":"Secret used for HMAC signature generation (if method is hmac)"}],"apiKey":[{"type":"string","description":"API key value (if method is api_key)"}],"apiKeyHeader":[{"type":"string","description":"Custom header name for API key (if method is api_key)"}],"userName":[{"type":"string","description":"Username for basic authentication (if method is basic)"}],"password":[{"type":"string","description":"Password for basic authentication (if method is basic)"}]},"description":"Authentication method configuration"}],"createdAt":[{"type":"string","description":"Timestamp when the webhook was created"}],"updatedAt":[{"type":"string","description":"Timestamp when the webhook was last updated"}]},"description":"The created webhook object"}]}}],"examples":{"example":{"value":{"success":true,"message":"\u003cstring>","data":{"id":"\u003cstring>","name":"\u003cstring>","url":"\u003cstring>","customHeaders":[{"key":"\u003cstring>","value":"\u003cstring>"}],"headers":[{"key":"\u003cstring>","value":"\u003cstring>"}],"authMethod":{"method":"\u003cstring>","hmacHeader":"\u003cstring>","hmacSecret":"\u003cstring>","apiKey":"\u003cstring>","apiKeyHeader":"\u003cstring>","userName":"\u003cstring>","password":"\u003cstring>"},"createdAt":"\u003cstring>","updatedAt":"\u003cstring>"}}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"vartiq","siteName":"Vartiq Docs","title":"Create Webhook - Vartiq Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-11-11T06:35:19.742Z","originalFileLocation":"api-reference/webhooks/create-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=\"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=\"application-name\" content=\"Vartiq Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vartiq/z3dGOyilo4vJDjWf/_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/vartiq/z3dGOyilo4vJDjWf/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vartiq/z3dGOyilo4vJDjWf/_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/vartiq/z3dGOyilo4vJDjWf/_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/vartiq/z3dGOyilo4vJDjWf/_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/vartiq/z3dGOyilo4vJDjWf/_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/vartiq/z3dGOyilo4vJDjWf/_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/vartiq/z3dGOyilo4vJDjWf/_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/vartiq/z3dGOyilo4vJDjWf/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Webhook - Vartiq Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Vartiq Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.vartiq.com/api-reference/webhooks/create-webhook\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vartiq.mintlify.app/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Create+Webhook\u0026amp;theme=b24694da5fce21e217a50992\u0026amp;signature=6e9312bf110293f9c7dccf6f0a286a1df904179181f3238d48bf8abd2c3f53d1\">\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 Webhook - Vartiq Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vartiq.mintlify.app/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Create+Webhook\u0026amp;theme=b24694da5fce21e217a50992\u0026amp;signature=6e9312bf110293f9c7dccf6f0a286a1df904179181f3238d48bf8abd2c3f53d1\">\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/vartiq/z3dGOyilo4vJDjWf/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Vartiq Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1A1A1A\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"22lkColhdFRi7seZXhlzCnHi_Yz4I1D8TNjN0mhLXkM\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.vartiq.com/api-reference/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/webhooks/create-webhook.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.vartiq.com/#organization\",\"name\":\"Vartiq Docs\",\"url\":\"https://docs.vartiq.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vartiq/RaHI3S0p6T4OPVWe/logo/light.svg?fit=max\u0026auto=format\u0026n=RaHI3S0p6T4OPVWe\u0026q=85\u0026s=176d03edd48a11f900335f104fa5a5ab\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.vartiq.com#website\",\"name\":\"Vartiq Docs\",\"url\":\"https://docs.vartiq.com\",\"publisher\":{\"@id\":\"https://docs.vartiq.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.vartiq.com/api-reference/webhooks/create-webhook#webpage\",\"url\":\"https://docs.vartiq.com/api-reference/webhooks/create-webhook\",\"name\":\"Create Webhook\",\"dateModified\":\"2025-11-11T06:35:19.742Z\",\"isPartOf\":{\"@id\":\"https://docs.vartiq.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.vartiq.com/api-reference/webhooks/create-webhook#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.vartiq.com/api-reference/webhooks/create-webhook#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.vartiq.com/api-reference/projects/create-project\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Webhook\",\"item\":\"https://docs.vartiq.com/api-reference/webhooks/create-webhook\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.vartiq.com/api-reference/webhooks/create-webhook#apireference\",\"headline\":\"Create Webhook\",\"name\":\"Create Webhook\",\"url\":\"https://docs.vartiq.com/api-reference/webhooks/create-webhook\",\"mainEntityOfPage\":{\"@id\":\"https://docs.vartiq.com/api-reference/webhooks/create-webhook#webpage\"},\"dateModified\":\"2025-11-11T06:35:19.742Z\",\"publisher\":{\"@id\":\"https://docs.vartiq.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.vartiq.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Vartiq Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Vartiq Docs","nav":{"global":null,"groups":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/index"},{"title":"Quickstart","href":"/quickstart"}]},{"group":"Essentials","pages":[{"title":"Webhook Authentication","href":"/essentials/authentication"},{"title":"Verify Webhook","href":"/essentials/verify"},{"title":"Retry Schedules","href":"/essentials/retry-schedule"}]},{"group":"Usage","pages":[{"title":"Initialize the SDK","href":"/usage/init"},{"title":"Projects","href":"/usage/projects"},{"title":"Apps","href":"/usage/apps"},{"title":"Webhooks","href":"/usage/webhooks"},{"title":"Webhook Messages","href":"/usage/webhook-messages"}]},{"group":"API Reference","pages":[{"group":"Projects","pages":[{"title":"Create Project","api":"POST /projects","href":"/api-reference/projects/create-project"},{"title":"Update Project","api":"PUT /api/v1/projects/{projectId}","href":"/api-reference/projects/update-project"},{"title":"Delete Project","api":"DELETE /api/v1/projects/{projectId}","href":"/api-reference/projects/delete-project"},{"title":"Get Project","api":"GET /api/v1/projects/{projectId}","href":"/api-reference/projects/get-project"},{"title":"Get Projects","api":"GET /api/v1/projects","href":"/api-reference/projects/get-projects"}]},{"group":"Apps","pages":[{"title":"Create App","api":"POST /apps","href":"/api-reference/apps/create-app"},{"title":"Update App","api":"PUT /apps/{appId}","href":"/api-reference/apps/update-app"},{"title":"Delete App","api":"DELETE /apps/{appId}","href":"/api-reference/apps/delete-app"},{"title":"Get App","api":"GET /apps/{appId}","href":"/api-reference/apps/get-app"},{"title":"Get Apps","api":"GET /apps","description":null,"href":"/api-reference/apps/get-apps"}]},{"group":"Webhooks","pages":[{"title":"Create Webhook","api":"POST /webhooks","href":"/api-reference/webhooks/create-webhook"},{"title":"Update Webhook","api":"PUT /webhooks/{webhookId}","description":null,"href":"/api-reference/webhooks/update-webhook"},{"title":"Delete Webhook","api":"DELETE /webhooks/{webhookId}","href":"/api-reference/webhooks/delete-webhook"},{"title":"Get Webhook","api":"GET /webhooks/{webhookId}","href":"/api-reference/webhooks/get-webhook"},{"title":"Get Webhooks","api":"GET /webhooks","href":"/api-reference/webhooks/get-webhooks"}]},{"group":"Webhook Messages","pages":[{"title":"Webhook Message","api":"POST /webhook-messages","href":"/api-reference/webhook-messages/webhook-message"}]}]}]},"basePath":"","title":"Create Webhook - Vartiq Docs","buildId":"dpl_2gSLkbMoF5kkLsBqYzq9KWtDyJRo","deploymentId":"dpl_2gSLkbMoF5kkLsBqYzq9KWtDyJRo","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-hfTk6MZX.js","utils-Bfp7HcY4.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D8dSW7yV.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CFgQXcZO.js","snippetPresets-dMW1-pV3.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-DyrCOido.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Bwwdcyh3.js","shallow-drVXTg79.js","getApiPlaygroundDisplay-GMPxUzWV.js","CodeSnippet-wTmV0wP6.js","CodeSnippets-D_QxCJEq.js","Page-BsZAA8xk.js","getPastedJson-Dev-X0Xy.js","icon-7L2WL0jD.js","MethodPill-Ble59Dl_.js","DuplicateIcon-r-98uLGh.js","createIcon-DaFzipjW.js","DynamicMarkdown-Jk8YAWGN.js","SectionHeading-nLgrCDOg.js","axios-vUo_bRtp.js"]}